From f4cfaae2c11c510f4871ffe20a4b96b14633963d Mon Sep 17 00:00:00 2001 From: Pearl Dsilva Date: Fri, 31 Mar 2023 02:24:05 -0400 Subject: [PATCH] Add ACS 4.17 support (#38) * Add ACS 4.17 support * update 4.17 apis Signed-off-by: Abhishek Kumar * add 4.17 new apis Signed-off-by: Abhishek Kumar --------- Signed-off-by: Abhishek Kumar Co-authored-by: dahn Co-authored-by: Abhishek Kumar --- cloudstack/AccountService.go | 8 +- cloudstack/AddressService.go | 90 + cloudstack/AddressService_mock.go | 29 + cloudstack/AffinityGroupService.go | 2 +- cloudstack/BrocadeVCSService.go | 6 + cloudstack/DiskOfferingService.go | 58 + cloudstack/EventService.go | 69 +- cloudstack/FirewallService.go | 979 + cloudstack/FirewallService_mock.go | 137 + cloudstack/ISOService.go | 4 +- cloudstack/InfrastructureUsageService.go | 366 + cloudstack/InfrastructureUsageService_mock.go | 174 + cloudstack/InternalLBService.go | 3 + cloudstack/KubernetesService.go | 8 + cloudstack/NetworkACLService.go | 2 + cloudstack/NetworkOfferingService.go | 21 + cloudstack/NetworkService.go | 950 + cloudstack/NetworkService_mock.go | 224 + cloudstack/NicService.go | 4 +- cloudstack/PodService.go | 6 + cloudstack/RouterService.go | 6 + cloudstack/SSHService.go | 26 +- cloudstack/SSHService_mock.go | 8 +- cloudstack/ServiceOfferingService.go | 49 + cloudstack/SnapshotService.go | 2 +- cloudstack/SystemVMService.go | 96 + cloudstack/SystemVMService_mock.go | 29 + cloudstack/TemplateService.go | 287 + cloudstack/TemplateService_mock.go | 79 + cloudstack/UsageService.go | 52 + cloudstack/UsageService_mock.go | 29 + cloudstack/UserService.go | 8 +- cloudstack/VLANService.go | 212 + cloudstack/VLANService_mock.go | 29 + cloudstack/VPCService.go | 156 +- cloudstack/VPCService_mock.go | 8 +- cloudstack/VirtualMachineService.go | 610 +- cloudstack/VirtualMachineService_mock.go | 92 + cloudstack/VolumeService.go | 271 + cloudstack/VolumeService_mock.go | 29 + cloudstack/cloudstack.go | 11 + generate/layout.go | 23 + generate/listApis.json | 117077 ++++++++------- test/AddressService_test.go | 12 + test/FirewallService_test.go | 54 + test/InfrastructureUsageService_test.go | 62 + test/NetworkService_test.go | 87 + test/SSHService_test.go | 2 +- test/SystemVMService_test.go | 12 + test/TemplateService_test.go | 24 + test/UsageService_test.go | 12 + test/VLANService_test.go | 12 + test/VPCService_test.go | 2 +- test/VirtualMachineService_test.go | 12 + test/VolumeService_test.go | 15 + test/testdata/KubernetesService.json | 48 +- 56 files changed, 64861 insertions(+), 57822 deletions(-) create mode 100644 cloudstack/InfrastructureUsageService.go create mode 100644 cloudstack/InfrastructureUsageService_mock.go create mode 100644 test/InfrastructureUsageService_test.go diff --git a/cloudstack/AccountService.go b/cloudstack/AccountService.go index 478500d..0e9d4a6 100644 --- a/cloudstack/AccountService.go +++ b/cloudstack/AccountService.go @@ -1004,7 +1004,7 @@ func (p *ListAccountsParams) toURLValues() url.Values { return u } if v, found := p.p["accounttype"]; found { - vv := strconv.FormatInt(v.(int64), 10) + vv := strconv.Itoa(v.(int)) u.Set("accounttype", vv) } if v, found := p.p["details"]; found { @@ -1053,18 +1053,18 @@ func (p *ListAccountsParams) toURLValues() url.Values { return u } -func (p *ListAccountsParams) SetAccounttype(v int64) { +func (p *ListAccountsParams) SetAccounttype(v int) { if p.p == nil { p.p = make(map[string]interface{}) } p.p["accounttype"] = v } -func (p *ListAccountsParams) GetAccounttype() (int64, bool) { +func (p *ListAccountsParams) GetAccounttype() (int, bool) { if p.p == nil { p.p = make(map[string]interface{}) } - value, ok := p.p["accounttype"].(int64) + value, ok := p.p["accounttype"].(int) return value, ok } diff --git a/cloudstack/AddressService.go b/cloudstack/AddressService.go index dacecc2..9fcbd9e 100644 --- a/cloudstack/AddressService.go +++ b/cloudstack/AddressService.go @@ -37,6 +37,8 @@ type AddressServiceIface interface { GetPublicIpAddressByID(id string, opts ...OptionFunc) (*PublicIpAddress, int, error) UpdateIpAddress(p *UpdateIpAddressParams) (*UpdateIpAddressResponse, error) NewUpdateIpAddressParams(id string) *UpdateIpAddressParams + ReleaseIpAddress(p *ReleaseIpAddressParams) (*ReleaseIpAddressResponse, error) + NewReleaseIpAddressParams(id string) *ReleaseIpAddressParams } type AssociateIpAddressParams struct { @@ -1096,3 +1098,91 @@ type UpdateIpAddressResponse struct { Zoneid string `json:"zoneid"` Zonename string `json:"zonename"` } + +type ReleaseIpAddressParams struct { + p map[string]interface{} +} + +func (p *ReleaseIpAddressParams) toURLValues() url.Values { + u := url.Values{} + if p.p == nil { + return u + } + if v, found := p.p["id"]; found { + u.Set("id", v.(string)) + } + return u +} + +func (p *ReleaseIpAddressParams) SetId(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["id"] = v +} + +func (p *ReleaseIpAddressParams) GetId() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["id"].(string) + return value, ok +} + +// You should always use this function to get a new ReleaseIpAddressParams instance, +// as then you are sure you have configured all required params +func (s *AddressService) NewReleaseIpAddressParams(id string) *ReleaseIpAddressParams { + p := &ReleaseIpAddressParams{} + p.p = make(map[string]interface{}) + p.p["id"] = id + return p +} + +// Releases an IP address from the account. +func (s *AddressService) ReleaseIpAddress(p *ReleaseIpAddressParams) (*ReleaseIpAddressResponse, error) { + resp, err := s.cs.newRequest("releaseIpAddress", p.toURLValues()) + if err != nil { + return nil, err + } + + var r ReleaseIpAddressResponse + if err := json.Unmarshal(resp, &r); err != nil { + return nil, err + } + + return &r, nil +} + +type ReleaseIpAddressResponse struct { + Displaytext string `json:"displaytext"` + JobID string `json:"jobid"` + Jobstatus int `json:"jobstatus"` + Success bool `json:"success"` +} + +func (r *ReleaseIpAddressResponse) UnmarshalJSON(b []byte) error { + var m map[string]interface{} + err := json.Unmarshal(b, &m) + if err != nil { + return err + } + + if success, ok := m["success"].(string); ok { + m["success"] = success == "true" + b, err = json.Marshal(m) + if err != nil { + return err + } + } + + if ostypeid, ok := m["ostypeid"].(float64); ok { + m["ostypeid"] = strconv.Itoa(int(ostypeid)) + b, err = json.Marshal(m) + if err != nil { + return err + } + } + + type alias ReleaseIpAddressResponse + return json.Unmarshal(b, (*alias)(r)) +} diff --git a/cloudstack/AddressService_mock.go b/cloudstack/AddressService_mock.go index e9032ae..fb587a8 100644 --- a/cloudstack/AddressService_mock.go +++ b/cloudstack/AddressService_mock.go @@ -160,6 +160,20 @@ func (mr *MockAddressServiceIfaceMockRecorder) NewListPublicIpAddressesParams() return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "NewListPublicIpAddressesParams", reflect.TypeOf((*MockAddressServiceIface)(nil).NewListPublicIpAddressesParams)) } +// NewReleaseIpAddressParams mocks base method. +func (m *MockAddressServiceIface) NewReleaseIpAddressParams(id string) *ReleaseIpAddressParams { + m.ctrl.T.Helper() + ret := m.ctrl.Call(m, "NewReleaseIpAddressParams", id) + ret0, _ := ret[0].(*ReleaseIpAddressParams) + return ret0 +} + +// NewReleaseIpAddressParams indicates an expected call of NewReleaseIpAddressParams. +func (mr *MockAddressServiceIfaceMockRecorder) NewReleaseIpAddressParams(id interface{}) *gomock.Call { + mr.mock.ctrl.T.Helper() + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "NewReleaseIpAddressParams", reflect.TypeOf((*MockAddressServiceIface)(nil).NewReleaseIpAddressParams), id) +} + // NewUpdateIpAddressParams mocks base method. func (m *MockAddressServiceIface) NewUpdateIpAddressParams(id string) *UpdateIpAddressParams { m.ctrl.T.Helper() @@ -174,6 +188,21 @@ func (mr *MockAddressServiceIfaceMockRecorder) NewUpdateIpAddressParams(id inter return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "NewUpdateIpAddressParams", reflect.TypeOf((*MockAddressServiceIface)(nil).NewUpdateIpAddressParams), id) } +// ReleaseIpAddress mocks base method. +func (m *MockAddressServiceIface) ReleaseIpAddress(p *ReleaseIpAddressParams) (*ReleaseIpAddressResponse, error) { + m.ctrl.T.Helper() + ret := m.ctrl.Call(m, "ReleaseIpAddress", p) + ret0, _ := ret[0].(*ReleaseIpAddressResponse) + ret1, _ := ret[1].(error) + return ret0, ret1 +} + +// ReleaseIpAddress indicates an expected call of ReleaseIpAddress. +func (mr *MockAddressServiceIfaceMockRecorder) ReleaseIpAddress(p interface{}) *gomock.Call { + mr.mock.ctrl.T.Helper() + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "ReleaseIpAddress", reflect.TypeOf((*MockAddressServiceIface)(nil).ReleaseIpAddress), p) +} + // UpdateIpAddress mocks base method. func (m *MockAddressServiceIface) UpdateIpAddress(p *UpdateIpAddressParams) (*UpdateIpAddressResponse, error) { m.ctrl.T.Helper() diff --git a/cloudstack/AffinityGroupService.go b/cloudstack/AffinityGroupService.go index fcaa8cc..6f15ea5 100644 --- a/cloudstack/AffinityGroupService.go +++ b/cloudstack/AffinityGroupService.go @@ -990,7 +990,7 @@ type UpdateVMAffinityGroupResponse struct { Isoname string `json:"isoname"` JobID string `json:"jobid"` Jobstatus int `json:"jobstatus"` - Keypair string `json:"keypair"` + Keypairs string `json:"keypairs"` Lastupdated string `json:"lastupdated"` Memory int `json:"memory"` Memoryintfreekbs int64 `json:"memoryintfreekbs"` diff --git a/cloudstack/BrocadeVCSService.go b/cloudstack/BrocadeVCSService.go index ac1930f..e647785 100644 --- a/cloudstack/BrocadeVCSService.go +++ b/cloudstack/BrocadeVCSService.go @@ -412,6 +412,8 @@ type BrocadeVcsDeviceNetwork struct { Aclid string `json:"aclid"` Aclname string `json:"aclname"` Acltype string `json:"acltype"` + Associatednetwork string `json:"associatednetwork"` + Associatednetworkid string `json:"associatednetworkid"` Broadcastdomaintype string `json:"broadcastdomaintype"` Broadcasturi string `json:"broadcasturi"` Canusefordeploy bool `json:"canusefordeploy"` @@ -424,13 +426,17 @@ type BrocadeVcsDeviceNetwork struct { Dns2 string `json:"dns2"` Domain string `json:"domain"` Domainid string `json:"domainid"` + Egressdefaultpolicy bool `json:"egressdefaultpolicy"` Externalid string `json:"externalid"` Gateway string `json:"gateway"` Hasannotations bool `json:"hasannotations"` Icon interface{} `json:"icon"` Id string `json:"id"` + Internetprotocol string `json:"internetprotocol"` Ip6cidr string `json:"ip6cidr"` Ip6gateway string `json:"ip6gateway"` + Ip6routes []interface{} `json:"ip6routes"` + Ip6routing string `json:"ip6routing"` Isdefault bool `json:"isdefault"` Ispersistent bool `json:"ispersistent"` Issystem bool `json:"issystem"` diff --git a/cloudstack/DiskOfferingService.go b/cloudstack/DiskOfferingService.go index 85b886a..b24d0b3 100644 --- a/cloudstack/DiskOfferingService.go +++ b/cloudstack/DiskOfferingService.go @@ -95,6 +95,10 @@ func (p *CreateDiskOfferingParams) toURLValues() url.Values { vv := strconv.FormatInt(v.(int64), 10) u.Set("disksize", vv) } + if v, found := p.p["disksizestrictness"]; found { + vv := strconv.FormatBool(v.(bool)) + u.Set("disksizestrictness", vv) + } if v, found := p.p["displayoffering"]; found { vv := strconv.FormatBool(v.(bool)) u.Set("displayoffering", vv) @@ -329,6 +333,21 @@ func (p *CreateDiskOfferingParams) GetDisksize() (int64, bool) { return value, ok } +func (p *CreateDiskOfferingParams) SetDisksizestrictness(v bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["disksizestrictness"] = v +} + +func (p *CreateDiskOfferingParams) GetDisksizestrictness() (bool, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["disksizestrictness"].(bool) + return value, ok +} + func (p *CreateDiskOfferingParams) SetDisplayoffering(v bool) { if p.p == nil { p.p = make(map[string]interface{}) @@ -644,6 +663,7 @@ type CreateDiskOfferingResponse struct { DiskIopsWriteRateMax int64 `json:"diskIopsWriteRateMax"` DiskIopsWriteRateMaxLength int64 `json:"diskIopsWriteRateMaxLength"` Disksize int64 `json:"disksize"` + Disksizestrictness bool `json:"disksizestrictness"` Displayoffering bool `json:"displayoffering"` Displaytext string `json:"displaytext"` Domain string `json:"domain"` @@ -791,6 +811,12 @@ func (p *ListDiskOfferingsParams) toURLValues() url.Values { vv := strconv.Itoa(v.(int)) u.Set("pagesize", vv) } + if v, found := p.p["storageid"]; found { + u.Set("storageid", v.(string)) + } + if v, found := p.p["volumeid"]; found { + u.Set("volumeid", v.(string)) + } if v, found := p.p["zoneid"]; found { u.Set("zoneid", v.(string)) } @@ -917,6 +943,36 @@ func (p *ListDiskOfferingsParams) GetPagesize() (int, bool) { return value, ok } +func (p *ListDiskOfferingsParams) SetStorageid(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["storageid"] = v +} + +func (p *ListDiskOfferingsParams) GetStorageid() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["storageid"].(string) + return value, ok +} + +func (p *ListDiskOfferingsParams) SetVolumeid(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["volumeid"] = v +} + +func (p *ListDiskOfferingsParams) GetVolumeid() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["volumeid"].(string) + return value, ok +} + func (p *ListDiskOfferingsParams) SetZoneid(v string) { if p.p == nil { p.p = make(map[string]interface{}) @@ -1059,6 +1115,7 @@ type DiskOffering struct { DiskIopsWriteRateMax int64 `json:"diskIopsWriteRateMax"` DiskIopsWriteRateMaxLength int64 `json:"diskIopsWriteRateMaxLength"` Disksize int64 `json:"disksize"` + Disksizestrictness bool `json:"disksizestrictness"` Displayoffering bool `json:"displayoffering"` Displaytext string `json:"displaytext"` Domain string `json:"domain"` @@ -1525,6 +1582,7 @@ type UpdateDiskOfferingResponse struct { DiskIopsWriteRateMax int64 `json:"diskIopsWriteRateMax"` DiskIopsWriteRateMaxLength int64 `json:"diskIopsWriteRateMaxLength"` Disksize int64 `json:"disksize"` + Disksizestrictness bool `json:"disksizestrictness"` Displayoffering bool `json:"displayoffering"` Displaytext string `json:"displaytext"` Domain string `json:"domain"` diff --git a/cloudstack/EventService.go b/cloudstack/EventService.go index e2dbd99..670bfb9 100644 --- a/cloudstack/EventService.go +++ b/cloudstack/EventService.go @@ -423,6 +423,12 @@ func (p *ListEventsParams) toURLValues() url.Values { if v, found := p.p["projectid"]; found { u.Set("projectid", v.(string)) } + if v, found := p.p["resourceid"]; found { + u.Set("resourceid", v.(string)) + } + if v, found := p.p["resourcetype"]; found { + u.Set("resourcetype", v.(string)) + } if v, found := p.p["startdate"]; found { u.Set("startdate", v.(string)) } @@ -630,6 +636,36 @@ func (p *ListEventsParams) GetProjectid() (string, bool) { return value, ok } +func (p *ListEventsParams) SetResourceid(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["resourceid"] = v +} + +func (p *ListEventsParams) GetResourceid() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["resourceid"].(string) + return value, ok +} + +func (p *ListEventsParams) SetResourcetype(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["resourcetype"] = v +} + +func (p *ListEventsParams) GetResourcetype() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["resourcetype"].(string) + return value, ok +} + func (p *ListEventsParams) SetStartdate(v string) { if p.p == nil { p.p = make(map[string]interface{}) @@ -737,19 +773,22 @@ type ListEventsResponse struct { } type Event struct { - Account string `json:"account"` - Created string `json:"created"` - Description string `json:"description"` - Domain string `json:"domain"` - Domainid string `json:"domainid"` - Id string `json:"id"` - JobID string `json:"jobid"` - Jobstatus int `json:"jobstatus"` - Level string `json:"level"` - Parentid string `json:"parentid"` - Project string `json:"project"` - Projectid string `json:"projectid"` - State string `json:"state"` - Type string `json:"type"` - Username string `json:"username"` + Account string `json:"account"` + Created string `json:"created"` + Description string `json:"description"` + Domain string `json:"domain"` + Domainid string `json:"domainid"` + Id string `json:"id"` + JobID string `json:"jobid"` + Jobstatus int `json:"jobstatus"` + Level string `json:"level"` + Parentid string `json:"parentid"` + Project string `json:"project"` + Projectid string `json:"projectid"` + Resourceid string `json:"resourceid"` + Resourcename string `json:"resourcename"` + Resourcetype string `json:"resourcetype"` + State string `json:"state"` + Type string `json:"type"` + Username string `json:"username"` } diff --git a/cloudstack/FirewallService.go b/cloudstack/FirewallService.go index dd4f267..353cee9 100644 --- a/cloudstack/FirewallService.go +++ b/cloudstack/FirewallService.go @@ -113,6 +113,15 @@ type FirewallServiceIface interface { NewUpdateFirewallRuleParams(id string) *UpdateFirewallRuleParams UpdatePortForwardingRule(p *UpdatePortForwardingRuleParams) (*UpdatePortForwardingRuleResponse, error) NewUpdatePortForwardingRuleParams(id string) *UpdatePortForwardingRuleParams + ListIpv6FirewallRules(p *ListIpv6FirewallRulesParams) (*ListIpv6FirewallRulesResponse, error) + NewListIpv6FirewallRulesParams() *ListIpv6FirewallRulesParams + GetIpv6FirewallRuleByID(id string, opts ...OptionFunc) (*Ipv6FirewallRule, int, error) + CreateIpv6FirewallRule(p *CreateIpv6FirewallRuleParams) (*CreateIpv6FirewallRuleResponse, error) + NewCreateIpv6FirewallRuleParams(networkid string, protocol string) *CreateIpv6FirewallRuleParams + UpdateIpv6FirewallRule(p *UpdateIpv6FirewallRuleParams) (*UpdateIpv6FirewallRuleResponse, error) + NewUpdateIpv6FirewallRuleParams(id string) *UpdateIpv6FirewallRuleParams + DeleteIpv6FirewallRule(p *DeleteIpv6FirewallRuleParams) (*DeleteIpv6FirewallRuleResponse, error) + NewDeleteIpv6FirewallRuleParams(id string) *DeleteIpv6FirewallRuleParams } type AddPaloAltoFirewallParams struct { @@ -676,6 +685,7 @@ type CreateEgressFirewallRuleResponse struct { Startport int `json:"startport"` State string `json:"state"` Tags []Tags `json:"tags"` + Traffictype string `json:"traffictype"` } type CreateFirewallRuleParams struct { @@ -925,6 +935,7 @@ type CreateFirewallRuleResponse struct { Startport int `json:"startport"` State string `json:"state"` Tags []Tags `json:"tags"` + Traffictype string `json:"traffictype"` } type CreatePortForwardingRuleParams struct { @@ -1899,6 +1910,7 @@ type EgressFirewallRule struct { Startport int `json:"startport"` State string `json:"state"` Tags []Tags `json:"tags"` + Traffictype string `json:"traffictype"` } type ListFirewallRulesParams struct { @@ -2239,6 +2251,7 @@ type FirewallRule struct { Startport int `json:"startport"` State string `json:"state"` Tags []Tags `json:"tags"` + Traffictype string `json:"traffictype"` } type ListPaloAltoFirewallsParams struct { @@ -2875,6 +2888,7 @@ type UpdateEgressFirewallRuleResponse struct { Startport int `json:"startport"` State string `json:"state"` Tags []Tags `json:"tags"` + Traffictype string `json:"traffictype"` } type UpdateFirewallRuleParams struct { @@ -3010,6 +3024,7 @@ type UpdateFirewallRuleResponse struct { Startport int `json:"startport"` State string `json:"state"` Tags []Tags `json:"tags"` + Traffictype string `json:"traffictype"` } type UpdatePortForwardingRuleParams struct { @@ -3223,3 +3238,967 @@ type UpdatePortForwardingRuleResponse struct { Virtualmachinename string `json:"virtualmachinename"` Vmguestip string `json:"vmguestip"` } + +type ListIpv6FirewallRulesParams struct { + p map[string]interface{} +} + +func (p *ListIpv6FirewallRulesParams) toURLValues() url.Values { + u := url.Values{} + if p.p == nil { + return u + } + if v, found := p.p["account"]; found { + u.Set("account", v.(string)) + } + if v, found := p.p["domainid"]; found { + u.Set("domainid", v.(string)) + } + if v, found := p.p["fordisplay"]; found { + vv := strconv.FormatBool(v.(bool)) + u.Set("fordisplay", vv) + } + if v, found := p.p["id"]; found { + u.Set("id", v.(string)) + } + if v, found := p.p["isrecursive"]; found { + vv := strconv.FormatBool(v.(bool)) + u.Set("isrecursive", vv) + } + if v, found := p.p["keyword"]; found { + u.Set("keyword", v.(string)) + } + if v, found := p.p["listall"]; found { + vv := strconv.FormatBool(v.(bool)) + u.Set("listall", vv) + } + if v, found := p.p["networkid"]; found { + u.Set("networkid", v.(string)) + } + if v, found := p.p["page"]; found { + vv := strconv.Itoa(v.(int)) + u.Set("page", vv) + } + if v, found := p.p["pagesize"]; found { + vv := strconv.Itoa(v.(int)) + u.Set("pagesize", vv) + } + if v, found := p.p["projectid"]; found { + u.Set("projectid", v.(string)) + } + if v, found := p.p["tags"]; found { + m := v.(map[string]string) + for i, k := range getSortedKeysFromMap(m) { + u.Set(fmt.Sprintf("tags[%d].key", i), k) + u.Set(fmt.Sprintf("tags[%d].value", i), m[k]) + } + } + if v, found := p.p["traffictype"]; found { + u.Set("traffictype", v.(string)) + } + return u +} + +func (p *ListIpv6FirewallRulesParams) SetAccount(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["account"] = v +} + +func (p *ListIpv6FirewallRulesParams) GetAccount() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["account"].(string) + return value, ok +} + +func (p *ListIpv6FirewallRulesParams) SetDomainid(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["domainid"] = v +} + +func (p *ListIpv6FirewallRulesParams) GetDomainid() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["domainid"].(string) + return value, ok +} + +func (p *ListIpv6FirewallRulesParams) SetFordisplay(v bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["fordisplay"] = v +} + +func (p *ListIpv6FirewallRulesParams) GetFordisplay() (bool, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["fordisplay"].(bool) + return value, ok +} + +func (p *ListIpv6FirewallRulesParams) SetId(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["id"] = v +} + +func (p *ListIpv6FirewallRulesParams) GetId() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["id"].(string) + return value, ok +} + +func (p *ListIpv6FirewallRulesParams) SetIsrecursive(v bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["isrecursive"] = v +} + +func (p *ListIpv6FirewallRulesParams) GetIsrecursive() (bool, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["isrecursive"].(bool) + return value, ok +} + +func (p *ListIpv6FirewallRulesParams) SetKeyword(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["keyword"] = v +} + +func (p *ListIpv6FirewallRulesParams) GetKeyword() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["keyword"].(string) + return value, ok +} + +func (p *ListIpv6FirewallRulesParams) SetListall(v bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["listall"] = v +} + +func (p *ListIpv6FirewallRulesParams) GetListall() (bool, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["listall"].(bool) + return value, ok +} + +func (p *ListIpv6FirewallRulesParams) SetNetworkid(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["networkid"] = v +} + +func (p *ListIpv6FirewallRulesParams) GetNetworkid() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["networkid"].(string) + return value, ok +} + +func (p *ListIpv6FirewallRulesParams) SetPage(v int) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["page"] = v +} + +func (p *ListIpv6FirewallRulesParams) GetPage() (int, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["page"].(int) + return value, ok +} + +func (p *ListIpv6FirewallRulesParams) SetPagesize(v int) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["pagesize"] = v +} + +func (p *ListIpv6FirewallRulesParams) GetPagesize() (int, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["pagesize"].(int) + return value, ok +} + +func (p *ListIpv6FirewallRulesParams) SetProjectid(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["projectid"] = v +} + +func (p *ListIpv6FirewallRulesParams) GetProjectid() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["projectid"].(string) + return value, ok +} + +func (p *ListIpv6FirewallRulesParams) SetTags(v map[string]string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["tags"] = v +} + +func (p *ListIpv6FirewallRulesParams) GetTags() (map[string]string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["tags"].(map[string]string) + return value, ok +} + +func (p *ListIpv6FirewallRulesParams) SetTraffictype(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["traffictype"] = v +} + +func (p *ListIpv6FirewallRulesParams) GetTraffictype() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["traffictype"].(string) + return value, ok +} + +// You should always use this function to get a new ListIpv6FirewallRulesParams instance, +// as then you are sure you have configured all required params +func (s *FirewallService) NewListIpv6FirewallRulesParams() *ListIpv6FirewallRulesParams { + p := &ListIpv6FirewallRulesParams{} + p.p = make(map[string]interface{}) + return p +} + +// This is a courtesy helper function, which in some cases may not work as expected! +func (s *FirewallService) GetIpv6FirewallRuleByID(id string, opts ...OptionFunc) (*Ipv6FirewallRule, int, error) { + p := &ListIpv6FirewallRulesParams{} + p.p = make(map[string]interface{}) + + p.p["id"] = id + + for _, fn := range append(s.cs.options, opts...) { + if err := fn(s.cs, p); err != nil { + return nil, -1, err + } + } + + l, err := s.ListIpv6FirewallRules(p) + if err != nil { + if strings.Contains(err.Error(), fmt.Sprintf( + "Invalid parameter id value=%s due to incorrect long value format, "+ + "or entity does not exist", id)) { + return nil, 0, fmt.Errorf("No match found for %s: %+v", id, l) + } + return nil, -1, err + } + + if l.Count == 0 { + return nil, l.Count, fmt.Errorf("No match found for %s: %+v", id, l) + } + + if l.Count == 1 { + return l.Ipv6FirewallRules[0], l.Count, nil + } + return nil, l.Count, fmt.Errorf("There is more then one result for Ipv6FirewallRule UUID: %s!", id) +} + +// Lists all IPv6 firewall rules +func (s *FirewallService) ListIpv6FirewallRules(p *ListIpv6FirewallRulesParams) (*ListIpv6FirewallRulesResponse, error) { + resp, err := s.cs.newRequest("listIpv6FirewallRules", p.toURLValues()) + if err != nil { + return nil, err + } + + resp, err = convertFirewallServiceResponse(resp) + if err != nil { + return nil, err + } + + var r ListIpv6FirewallRulesResponse + if err := json.Unmarshal(resp, &r); err != nil { + return nil, err + } + + return &r, nil +} + +type ListIpv6FirewallRulesResponse struct { + Count int `json:"count"` + Ipv6FirewallRules []*Ipv6FirewallRule `json:"ipv6firewallrule"` +} + +type Ipv6FirewallRule struct { + Cidrlist string `json:"cidrlist"` + Fordisplay bool `json:"fordisplay"` + Id string `json:"id"` + Ipaddress string `json:"ipaddress"` + Ipaddressid string `json:"ipaddressid"` + JobID string `json:"jobid"` + Jobstatus int `json:"jobstatus"` + Networkid string `json:"networkid"` + Privateendport string `json:"privateendport"` + Privateport string `json:"privateport"` + Protocol string `json:"protocol"` + Publicendport string `json:"publicendport"` + Publicport string `json:"publicport"` + State string `json:"state"` + Tags []Tags `json:"tags"` + Virtualmachinedisplayname string `json:"virtualmachinedisplayname"` + Virtualmachineid string `json:"virtualmachineid"` + Virtualmachinename string `json:"virtualmachinename"` + Vmguestip string `json:"vmguestip"` +} + +type CreateIpv6FirewallRuleParams struct { + p map[string]interface{} +} + +func (p *CreateIpv6FirewallRuleParams) toURLValues() url.Values { + u := url.Values{} + if p.p == nil { + return u + } + if v, found := p.p["cidrlist"]; found { + vv := strings.Join(v.([]string), ",") + u.Set("cidrlist", vv) + } + if v, found := p.p["destcidrlist"]; found { + vv := strings.Join(v.([]string), ",") + u.Set("destcidrlist", vv) + } + if v, found := p.p["endport"]; found { + vv := strconv.Itoa(v.(int)) + u.Set("endport", vv) + } + if v, found := p.p["fordisplay"]; found { + vv := strconv.FormatBool(v.(bool)) + u.Set("fordisplay", vv) + } + if v, found := p.p["icmpcode"]; found { + vv := strconv.Itoa(v.(int)) + u.Set("icmpcode", vv) + } + if v, found := p.p["icmptype"]; found { + vv := strconv.Itoa(v.(int)) + u.Set("icmptype", vv) + } + if v, found := p.p["networkid"]; found { + u.Set("networkid", v.(string)) + } + if v, found := p.p["protocol"]; found { + u.Set("protocol", v.(string)) + } + if v, found := p.p["startport"]; found { + vv := strconv.Itoa(v.(int)) + u.Set("startport", vv) + } + if v, found := p.p["traffictype"]; found { + u.Set("traffictype", v.(string)) + } + return u +} + +func (p *CreateIpv6FirewallRuleParams) SetCidrlist(v []string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["cidrlist"] = v +} + +func (p *CreateIpv6FirewallRuleParams) GetCidrlist() ([]string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["cidrlist"].([]string) + return value, ok +} + +func (p *CreateIpv6FirewallRuleParams) SetDestcidrlist(v []string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["destcidrlist"] = v +} + +func (p *CreateIpv6FirewallRuleParams) GetDestcidrlist() ([]string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["destcidrlist"].([]string) + return value, ok +} + +func (p *CreateIpv6FirewallRuleParams) SetEndport(v int) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["endport"] = v +} + +func (p *CreateIpv6FirewallRuleParams) GetEndport() (int, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["endport"].(int) + return value, ok +} + +func (p *CreateIpv6FirewallRuleParams) SetFordisplay(v bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["fordisplay"] = v +} + +func (p *CreateIpv6FirewallRuleParams) GetFordisplay() (bool, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["fordisplay"].(bool) + return value, ok +} + +func (p *CreateIpv6FirewallRuleParams) SetIcmpcode(v int) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["icmpcode"] = v +} + +func (p *CreateIpv6FirewallRuleParams) GetIcmpcode() (int, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["icmpcode"].(int) + return value, ok +} + +func (p *CreateIpv6FirewallRuleParams) SetIcmptype(v int) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["icmptype"] = v +} + +func (p *CreateIpv6FirewallRuleParams) GetIcmptype() (int, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["icmptype"].(int) + return value, ok +} + +func (p *CreateIpv6FirewallRuleParams) SetNetworkid(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["networkid"] = v +} + +func (p *CreateIpv6FirewallRuleParams) GetNetworkid() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["networkid"].(string) + return value, ok +} + +func (p *CreateIpv6FirewallRuleParams) SetProtocol(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["protocol"] = v +} + +func (p *CreateIpv6FirewallRuleParams) GetProtocol() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["protocol"].(string) + return value, ok +} + +func (p *CreateIpv6FirewallRuleParams) SetStartport(v int) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["startport"] = v +} + +func (p *CreateIpv6FirewallRuleParams) GetStartport() (int, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["startport"].(int) + return value, ok +} + +func (p *CreateIpv6FirewallRuleParams) SetTraffictype(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["traffictype"] = v +} + +func (p *CreateIpv6FirewallRuleParams) GetTraffictype() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["traffictype"].(string) + return value, ok +} + +// You should always use this function to get a new CreateIpv6FirewallRuleParams instance, +// as then you are sure you have configured all required params +func (s *FirewallService) NewCreateIpv6FirewallRuleParams(networkid string, protocol string) *CreateIpv6FirewallRuleParams { + p := &CreateIpv6FirewallRuleParams{} + p.p = make(map[string]interface{}) + p.p["networkid"] = networkid + p.p["protocol"] = protocol + return p +} + +// Creates an Ipv6 firewall rule in the given network (the network has to belong to VPC) +func (s *FirewallService) CreateIpv6FirewallRule(p *CreateIpv6FirewallRuleParams) (*CreateIpv6FirewallRuleResponse, error) { + resp, err := s.cs.newRequest("createIpv6FirewallRule", p.toURLValues()) + if err != nil { + return nil, err + } + + var r CreateIpv6FirewallRuleResponse + if err := json.Unmarshal(resp, &r); err != nil { + return nil, err + } + + // If we have a async client, we need to wait for the async result + if s.cs.async { + b, err := s.cs.GetAsyncJobResult(r.JobID, s.cs.timeout) + if err != nil { + if err == AsyncTimeoutErr { + return &r, err + } + return nil, err + } + + b, err = getRawValue(b) + if err != nil { + return nil, err + } + + b, err = convertFirewallServiceResponse(b) + if err != nil { + return nil, err + } + + if err := json.Unmarshal(b, &r); err != nil { + return nil, err + } + } + + return &r, nil +} + +type CreateIpv6FirewallRuleResponse struct { + Cidrlist string `json:"cidrlist"` + Fordisplay bool `json:"fordisplay"` + Id string `json:"id"` + Ipaddress string `json:"ipaddress"` + Ipaddressid string `json:"ipaddressid"` + JobID string `json:"jobid"` + Jobstatus int `json:"jobstatus"` + Networkid string `json:"networkid"` + Privateendport string `json:"privateendport"` + Privateport string `json:"privateport"` + Protocol string `json:"protocol"` + Publicendport string `json:"publicendport"` + Publicport string `json:"publicport"` + State string `json:"state"` + Tags []Tags `json:"tags"` + Virtualmachinedisplayname string `json:"virtualmachinedisplayname"` + Virtualmachineid string `json:"virtualmachineid"` + Virtualmachinename string `json:"virtualmachinename"` + Vmguestip string `json:"vmguestip"` +} + +type UpdateIpv6FirewallRuleParams struct { + p map[string]interface{} +} + +func (p *UpdateIpv6FirewallRuleParams) toURLValues() url.Values { + u := url.Values{} + if p.p == nil { + return u + } + if v, found := p.p["cidrlist"]; found { + vv := strings.Join(v.([]string), ",") + u.Set("cidrlist", vv) + } + if v, found := p.p["customid"]; found { + u.Set("customid", v.(string)) + } + if v, found := p.p["endport"]; found { + vv := strconv.Itoa(v.(int)) + u.Set("endport", vv) + } + if v, found := p.p["fordisplay"]; found { + vv := strconv.FormatBool(v.(bool)) + u.Set("fordisplay", vv) + } + if v, found := p.p["icmpcode"]; found { + vv := strconv.Itoa(v.(int)) + u.Set("icmpcode", vv) + } + if v, found := p.p["icmptype"]; found { + vv := strconv.Itoa(v.(int)) + u.Set("icmptype", vv) + } + if v, found := p.p["id"]; found { + u.Set("id", v.(string)) + } + if v, found := p.p["protocol"]; found { + u.Set("protocol", v.(string)) + } + if v, found := p.p["startport"]; found { + vv := strconv.Itoa(v.(int)) + u.Set("startport", vv) + } + if v, found := p.p["traffictype"]; found { + u.Set("traffictype", v.(string)) + } + return u +} + +func (p *UpdateIpv6FirewallRuleParams) SetCidrlist(v []string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["cidrlist"] = v +} + +func (p *UpdateIpv6FirewallRuleParams) GetCidrlist() ([]string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["cidrlist"].([]string) + return value, ok +} + +func (p *UpdateIpv6FirewallRuleParams) SetCustomid(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["customid"] = v +} + +func (p *UpdateIpv6FirewallRuleParams) GetCustomid() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["customid"].(string) + return value, ok +} + +func (p *UpdateIpv6FirewallRuleParams) SetEndport(v int) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["endport"] = v +} + +func (p *UpdateIpv6FirewallRuleParams) GetEndport() (int, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["endport"].(int) + return value, ok +} + +func (p *UpdateIpv6FirewallRuleParams) SetFordisplay(v bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["fordisplay"] = v +} + +func (p *UpdateIpv6FirewallRuleParams) GetFordisplay() (bool, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["fordisplay"].(bool) + return value, ok +} + +func (p *UpdateIpv6FirewallRuleParams) SetIcmpcode(v int) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["icmpcode"] = v +} + +func (p *UpdateIpv6FirewallRuleParams) GetIcmpcode() (int, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["icmpcode"].(int) + return value, ok +} + +func (p *UpdateIpv6FirewallRuleParams) SetIcmptype(v int) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["icmptype"] = v +} + +func (p *UpdateIpv6FirewallRuleParams) GetIcmptype() (int, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["icmptype"].(int) + return value, ok +} + +func (p *UpdateIpv6FirewallRuleParams) SetId(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["id"] = v +} + +func (p *UpdateIpv6FirewallRuleParams) GetId() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["id"].(string) + return value, ok +} + +func (p *UpdateIpv6FirewallRuleParams) SetProtocol(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["protocol"] = v +} + +func (p *UpdateIpv6FirewallRuleParams) GetProtocol() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["protocol"].(string) + return value, ok +} + +func (p *UpdateIpv6FirewallRuleParams) SetStartport(v int) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["startport"] = v +} + +func (p *UpdateIpv6FirewallRuleParams) GetStartport() (int, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["startport"].(int) + return value, ok +} + +func (p *UpdateIpv6FirewallRuleParams) SetTraffictype(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["traffictype"] = v +} + +func (p *UpdateIpv6FirewallRuleParams) GetTraffictype() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["traffictype"].(string) + return value, ok +} + +// You should always use this function to get a new UpdateIpv6FirewallRuleParams instance, +// as then you are sure you have configured all required params +func (s *FirewallService) NewUpdateIpv6FirewallRuleParams(id string) *UpdateIpv6FirewallRuleParams { + p := &UpdateIpv6FirewallRuleParams{} + p.p = make(map[string]interface{}) + p.p["id"] = id + return p +} + +// Updates Ipv6 firewall rule with specified ID +func (s *FirewallService) UpdateIpv6FirewallRule(p *UpdateIpv6FirewallRuleParams) (*UpdateIpv6FirewallRuleResponse, error) { + resp, err := s.cs.newRequest("updateIpv6FirewallRule", p.toURLValues()) + if err != nil { + return nil, err + } + + var r UpdateIpv6FirewallRuleResponse + if err := json.Unmarshal(resp, &r); err != nil { + return nil, err + } + + // If we have a async client, we need to wait for the async result + if s.cs.async { + b, err := s.cs.GetAsyncJobResult(r.JobID, s.cs.timeout) + if err != nil { + if err == AsyncTimeoutErr { + return &r, err + } + return nil, err + } + + b, err = getRawValue(b) + if err != nil { + return nil, err + } + + b, err = convertFirewallServiceResponse(b) + if err != nil { + return nil, err + } + + if err := json.Unmarshal(b, &r); err != nil { + return nil, err + } + } + + return &r, nil +} + +type UpdateIpv6FirewallRuleResponse struct { + Cidrlist string `json:"cidrlist"` + Fordisplay bool `json:"fordisplay"` + Id string `json:"id"` + Ipaddress string `json:"ipaddress"` + Ipaddressid string `json:"ipaddressid"` + JobID string `json:"jobid"` + Jobstatus int `json:"jobstatus"` + Networkid string `json:"networkid"` + Privateendport string `json:"privateendport"` + Privateport string `json:"privateport"` + Protocol string `json:"protocol"` + Publicendport string `json:"publicendport"` + Publicport string `json:"publicport"` + State string `json:"state"` + Tags []Tags `json:"tags"` + Virtualmachinedisplayname string `json:"virtualmachinedisplayname"` + Virtualmachineid string `json:"virtualmachineid"` + Virtualmachinename string `json:"virtualmachinename"` + Vmguestip string `json:"vmguestip"` +} + +type DeleteIpv6FirewallRuleParams struct { + p map[string]interface{} +} + +func (p *DeleteIpv6FirewallRuleParams) toURLValues() url.Values { + u := url.Values{} + if p.p == nil { + return u + } + if v, found := p.p["id"]; found { + u.Set("id", v.(string)) + } + return u +} + +func (p *DeleteIpv6FirewallRuleParams) SetId(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["id"] = v +} + +func (p *DeleteIpv6FirewallRuleParams) GetId() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["id"].(string) + return value, ok +} + +// You should always use this function to get a new DeleteIpv6FirewallRuleParams instance, +// as then you are sure you have configured all required params +func (s *FirewallService) NewDeleteIpv6FirewallRuleParams(id string) *DeleteIpv6FirewallRuleParams { + p := &DeleteIpv6FirewallRuleParams{} + p.p = make(map[string]interface{}) + p.p["id"] = id + return p +} + +// Deletes a IPv6 firewall rule +func (s *FirewallService) DeleteIpv6FirewallRule(p *DeleteIpv6FirewallRuleParams) (*DeleteIpv6FirewallRuleResponse, error) { + resp, err := s.cs.newRequest("deleteIpv6FirewallRule", p.toURLValues()) + if err != nil { + return nil, err + } + + var r DeleteIpv6FirewallRuleResponse + if err := json.Unmarshal(resp, &r); err != nil { + return nil, err + } + + // If we have a async client, we need to wait for the async result + if s.cs.async { + b, err := s.cs.GetAsyncJobResult(r.JobID, s.cs.timeout) + if err != nil { + if err == AsyncTimeoutErr { + return &r, err + } + return nil, err + } + + b, err = convertFirewallServiceResponse(b) + if err != nil { + return nil, err + } + + if err := json.Unmarshal(b, &r); err != nil { + return nil, err + } + } + + return &r, nil +} + +type DeleteIpv6FirewallRuleResponse struct { + Displaytext string `json:"displaytext"` + JobID string `json:"jobid"` + Jobstatus int `json:"jobstatus"` + Success bool `json:"success"` +} diff --git a/cloudstack/FirewallService_mock.go b/cloudstack/FirewallService_mock.go index 32e19bb..471a683 100644 --- a/cloudstack/FirewallService_mock.go +++ b/cloudstack/FirewallService_mock.go @@ -112,6 +112,21 @@ func (mr *MockFirewallServiceIfaceMockRecorder) CreateFirewallRule(p interface{} return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "CreateFirewallRule", reflect.TypeOf((*MockFirewallServiceIface)(nil).CreateFirewallRule), p) } +// CreateIpv6FirewallRule mocks base method. +func (m *MockFirewallServiceIface) CreateIpv6FirewallRule(p *CreateIpv6FirewallRuleParams) (*CreateIpv6FirewallRuleResponse, error) { + m.ctrl.T.Helper() + ret := m.ctrl.Call(m, "CreateIpv6FirewallRule", p) + ret0, _ := ret[0].(*CreateIpv6FirewallRuleResponse) + ret1, _ := ret[1].(error) + return ret0, ret1 +} + +// CreateIpv6FirewallRule indicates an expected call of CreateIpv6FirewallRule. +func (mr *MockFirewallServiceIfaceMockRecorder) CreateIpv6FirewallRule(p interface{}) *gomock.Call { + mr.mock.ctrl.T.Helper() + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "CreateIpv6FirewallRule", reflect.TypeOf((*MockFirewallServiceIface)(nil).CreateIpv6FirewallRule), p) +} + // CreatePortForwardingRule mocks base method. func (m *MockFirewallServiceIface) CreatePortForwardingRule(p *CreatePortForwardingRuleParams) (*CreatePortForwardingRuleResponse, error) { m.ctrl.T.Helper() @@ -157,6 +172,21 @@ func (mr *MockFirewallServiceIfaceMockRecorder) DeleteFirewallRule(p interface{} return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "DeleteFirewallRule", reflect.TypeOf((*MockFirewallServiceIface)(nil).DeleteFirewallRule), p) } +// DeleteIpv6FirewallRule mocks base method. +func (m *MockFirewallServiceIface) DeleteIpv6FirewallRule(p *DeleteIpv6FirewallRuleParams) (*DeleteIpv6FirewallRuleResponse, error) { + m.ctrl.T.Helper() + ret := m.ctrl.Call(m, "DeleteIpv6FirewallRule", p) + ret0, _ := ret[0].(*DeleteIpv6FirewallRuleResponse) + ret1, _ := ret[1].(error) + return ret0, ret1 +} + +// DeleteIpv6FirewallRule indicates an expected call of DeleteIpv6FirewallRule. +func (mr *MockFirewallServiceIfaceMockRecorder) DeleteIpv6FirewallRule(p interface{}) *gomock.Call { + mr.mock.ctrl.T.Helper() + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "DeleteIpv6FirewallRule", reflect.TypeOf((*MockFirewallServiceIface)(nil).DeleteIpv6FirewallRule), p) +} + // DeletePaloAltoFirewall mocks base method. func (m *MockFirewallServiceIface) DeletePaloAltoFirewall(p *DeletePaloAltoFirewallParams) (*DeletePaloAltoFirewallResponse, error) { m.ctrl.T.Helper() @@ -229,6 +259,27 @@ func (mr *MockFirewallServiceIfaceMockRecorder) GetFirewallRuleByID(id interface return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "GetFirewallRuleByID", reflect.TypeOf((*MockFirewallServiceIface)(nil).GetFirewallRuleByID), varargs...) } +// GetIpv6FirewallRuleByID mocks base method. +func (m *MockFirewallServiceIface) GetIpv6FirewallRuleByID(id string, opts ...OptionFunc) (*Ipv6FirewallRule, int, error) { + m.ctrl.T.Helper() + varargs := []interface{}{id} + for _, a := range opts { + varargs = append(varargs, a) + } + ret := m.ctrl.Call(m, "GetIpv6FirewallRuleByID", varargs...) + ret0, _ := ret[0].(*Ipv6FirewallRule) + ret1, _ := ret[1].(int) + ret2, _ := ret[2].(error) + return ret0, ret1, ret2 +} + +// GetIpv6FirewallRuleByID indicates an expected call of GetIpv6FirewallRuleByID. +func (mr *MockFirewallServiceIfaceMockRecorder) GetIpv6FirewallRuleByID(id interface{}, opts ...interface{}) *gomock.Call { + mr.mock.ctrl.T.Helper() + varargs := append([]interface{}{id}, opts...) + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "GetIpv6FirewallRuleByID", reflect.TypeOf((*MockFirewallServiceIface)(nil).GetIpv6FirewallRuleByID), varargs...) +} + // GetPortForwardingRuleByID mocks base method. func (m *MockFirewallServiceIface) GetPortForwardingRuleByID(id string, opts ...OptionFunc) (*PortForwardingRule, int, error) { m.ctrl.T.Helper() @@ -280,6 +331,21 @@ func (mr *MockFirewallServiceIfaceMockRecorder) ListFirewallRules(p interface{}) return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "ListFirewallRules", reflect.TypeOf((*MockFirewallServiceIface)(nil).ListFirewallRules), p) } +// ListIpv6FirewallRules mocks base method. +func (m *MockFirewallServiceIface) ListIpv6FirewallRules(p *ListIpv6FirewallRulesParams) (*ListIpv6FirewallRulesResponse, error) { + m.ctrl.T.Helper() + ret := m.ctrl.Call(m, "ListIpv6FirewallRules", p) + ret0, _ := ret[0].(*ListIpv6FirewallRulesResponse) + ret1, _ := ret[1].(error) + return ret0, ret1 +} + +// ListIpv6FirewallRules indicates an expected call of ListIpv6FirewallRules. +func (mr *MockFirewallServiceIfaceMockRecorder) ListIpv6FirewallRules(p interface{}) *gomock.Call { + mr.mock.ctrl.T.Helper() + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "ListIpv6FirewallRules", reflect.TypeOf((*MockFirewallServiceIface)(nil).ListIpv6FirewallRules), p) +} + // ListPaloAltoFirewalls mocks base method. func (m *MockFirewallServiceIface) ListPaloAltoFirewalls(p *ListPaloAltoFirewallsParams) (*ListPaloAltoFirewallsResponse, error) { m.ctrl.T.Helper() @@ -366,6 +432,20 @@ func (mr *MockFirewallServiceIfaceMockRecorder) NewCreateFirewallRuleParams(ipad return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "NewCreateFirewallRuleParams", reflect.TypeOf((*MockFirewallServiceIface)(nil).NewCreateFirewallRuleParams), ipaddressid, protocol) } +// NewCreateIpv6FirewallRuleParams mocks base method. +func (m *MockFirewallServiceIface) NewCreateIpv6FirewallRuleParams(networkid, protocol string) *CreateIpv6FirewallRuleParams { + m.ctrl.T.Helper() + ret := m.ctrl.Call(m, "NewCreateIpv6FirewallRuleParams", networkid, protocol) + ret0, _ := ret[0].(*CreateIpv6FirewallRuleParams) + return ret0 +} + +// NewCreateIpv6FirewallRuleParams indicates an expected call of NewCreateIpv6FirewallRuleParams. +func (mr *MockFirewallServiceIfaceMockRecorder) NewCreateIpv6FirewallRuleParams(networkid, protocol interface{}) *gomock.Call { + mr.mock.ctrl.T.Helper() + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "NewCreateIpv6FirewallRuleParams", reflect.TypeOf((*MockFirewallServiceIface)(nil).NewCreateIpv6FirewallRuleParams), networkid, protocol) +} + // NewCreatePortForwardingRuleParams mocks base method. func (m *MockFirewallServiceIface) NewCreatePortForwardingRuleParams(ipaddressid string, privateport int, protocol string, publicport int, virtualmachineid string) *CreatePortForwardingRuleParams { m.ctrl.T.Helper() @@ -408,6 +488,20 @@ func (mr *MockFirewallServiceIfaceMockRecorder) NewDeleteFirewallRuleParams(id i return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "NewDeleteFirewallRuleParams", reflect.TypeOf((*MockFirewallServiceIface)(nil).NewDeleteFirewallRuleParams), id) } +// NewDeleteIpv6FirewallRuleParams mocks base method. +func (m *MockFirewallServiceIface) NewDeleteIpv6FirewallRuleParams(id string) *DeleteIpv6FirewallRuleParams { + m.ctrl.T.Helper() + ret := m.ctrl.Call(m, "NewDeleteIpv6FirewallRuleParams", id) + ret0, _ := ret[0].(*DeleteIpv6FirewallRuleParams) + return ret0 +} + +// NewDeleteIpv6FirewallRuleParams indicates an expected call of NewDeleteIpv6FirewallRuleParams. +func (mr *MockFirewallServiceIfaceMockRecorder) NewDeleteIpv6FirewallRuleParams(id interface{}) *gomock.Call { + mr.mock.ctrl.T.Helper() + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "NewDeleteIpv6FirewallRuleParams", reflect.TypeOf((*MockFirewallServiceIface)(nil).NewDeleteIpv6FirewallRuleParams), id) +} + // NewDeletePaloAltoFirewallParams mocks base method. func (m *MockFirewallServiceIface) NewDeletePaloAltoFirewallParams(fwdeviceid string) *DeletePaloAltoFirewallParams { m.ctrl.T.Helper() @@ -464,6 +558,20 @@ func (mr *MockFirewallServiceIfaceMockRecorder) NewListFirewallRulesParams() *go return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "NewListFirewallRulesParams", reflect.TypeOf((*MockFirewallServiceIface)(nil).NewListFirewallRulesParams)) } +// NewListIpv6FirewallRulesParams mocks base method. +func (m *MockFirewallServiceIface) NewListIpv6FirewallRulesParams() *ListIpv6FirewallRulesParams { + m.ctrl.T.Helper() + ret := m.ctrl.Call(m, "NewListIpv6FirewallRulesParams") + ret0, _ := ret[0].(*ListIpv6FirewallRulesParams) + return ret0 +} + +// NewListIpv6FirewallRulesParams indicates an expected call of NewListIpv6FirewallRulesParams. +func (mr *MockFirewallServiceIfaceMockRecorder) NewListIpv6FirewallRulesParams() *gomock.Call { + mr.mock.ctrl.T.Helper() + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "NewListIpv6FirewallRulesParams", reflect.TypeOf((*MockFirewallServiceIface)(nil).NewListIpv6FirewallRulesParams)) +} + // NewListPaloAltoFirewallsParams mocks base method. func (m *MockFirewallServiceIface) NewListPaloAltoFirewallsParams() *ListPaloAltoFirewallsParams { m.ctrl.T.Helper() @@ -520,6 +628,20 @@ func (mr *MockFirewallServiceIfaceMockRecorder) NewUpdateFirewallRuleParams(id i return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "NewUpdateFirewallRuleParams", reflect.TypeOf((*MockFirewallServiceIface)(nil).NewUpdateFirewallRuleParams), id) } +// NewUpdateIpv6FirewallRuleParams mocks base method. +func (m *MockFirewallServiceIface) NewUpdateIpv6FirewallRuleParams(id string) *UpdateIpv6FirewallRuleParams { + m.ctrl.T.Helper() + ret := m.ctrl.Call(m, "NewUpdateIpv6FirewallRuleParams", id) + ret0, _ := ret[0].(*UpdateIpv6FirewallRuleParams) + return ret0 +} + +// NewUpdateIpv6FirewallRuleParams indicates an expected call of NewUpdateIpv6FirewallRuleParams. +func (mr *MockFirewallServiceIfaceMockRecorder) NewUpdateIpv6FirewallRuleParams(id interface{}) *gomock.Call { + mr.mock.ctrl.T.Helper() + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "NewUpdateIpv6FirewallRuleParams", reflect.TypeOf((*MockFirewallServiceIface)(nil).NewUpdateIpv6FirewallRuleParams), id) +} + // NewUpdatePortForwardingRuleParams mocks base method. func (m *MockFirewallServiceIface) NewUpdatePortForwardingRuleParams(id string) *UpdatePortForwardingRuleParams { m.ctrl.T.Helper() @@ -564,6 +686,21 @@ func (mr *MockFirewallServiceIfaceMockRecorder) UpdateFirewallRule(p interface{} return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "UpdateFirewallRule", reflect.TypeOf((*MockFirewallServiceIface)(nil).UpdateFirewallRule), p) } +// UpdateIpv6FirewallRule mocks base method. +func (m *MockFirewallServiceIface) UpdateIpv6FirewallRule(p *UpdateIpv6FirewallRuleParams) (*UpdateIpv6FirewallRuleResponse, error) { + m.ctrl.T.Helper() + ret := m.ctrl.Call(m, "UpdateIpv6FirewallRule", p) + ret0, _ := ret[0].(*UpdateIpv6FirewallRuleResponse) + ret1, _ := ret[1].(error) + return ret0, ret1 +} + +// UpdateIpv6FirewallRule indicates an expected call of UpdateIpv6FirewallRule. +func (mr *MockFirewallServiceIfaceMockRecorder) UpdateIpv6FirewallRule(p interface{}) *gomock.Call { + mr.mock.ctrl.T.Helper() + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "UpdateIpv6FirewallRule", reflect.TypeOf((*MockFirewallServiceIface)(nil).UpdateIpv6FirewallRule), p) +} + // UpdatePortForwardingRule mocks base method. func (m *MockFirewallServiceIface) UpdatePortForwardingRule(p *UpdatePortForwardingRuleParams) (*UpdatePortForwardingRuleResponse, error) { m.ctrl.T.Helper() diff --git a/cloudstack/ISOService.go b/cloudstack/ISOService.go index 9bdeba2..3fb883a 100644 --- a/cloudstack/ISOService.go +++ b/cloudstack/ISOService.go @@ -206,7 +206,7 @@ type AttachIsoResponse struct { Isoname string `json:"isoname"` JobID string `json:"jobid"` Jobstatus int `json:"jobstatus"` - Keypair string `json:"keypair"` + Keypairs string `json:"keypairs"` Lastupdated string `json:"lastupdated"` Memory int `json:"memory"` Memoryintfreekbs int64 `json:"memoryintfreekbs"` @@ -751,7 +751,7 @@ type DetachIsoResponse struct { Isoname string `json:"isoname"` JobID string `json:"jobid"` Jobstatus int `json:"jobstatus"` - Keypair string `json:"keypair"` + Keypairs string `json:"keypairs"` Lastupdated string `json:"lastupdated"` Memory int `json:"memory"` Memoryintfreekbs int64 `json:"memoryintfreekbs"` diff --git a/cloudstack/InfrastructureUsageService.go b/cloudstack/InfrastructureUsageService.go new file mode 100644 index 0000000..d8a2980 --- /dev/null +++ b/cloudstack/InfrastructureUsageService.go @@ -0,0 +1,366 @@ +// +// Licensed to the Apache Software Foundation (ASF) under one +// or more contributor license agreements. See the NOTICE file +// distributed with this work for additional information +// regarding copyright ownership. The ASF licenses this file +// to you under the Apache License, Version 2.0 (the +// "License"); you may not use this file except in compliance +// with the License. You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, +// software distributed under the License is distributed on an +// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +// KIND, either express or implied. See the License for the +// specific language governing permissions and limitations +// under the License. +// + +package cloudstack + +import ( + "encoding/json" + "fmt" + "net/url" + "strconv" + "strings" +) + +type InfrastructureUsageServiceIface interface { + ListManagementServersMetrics(p *ListManagementServersMetricsParams) (*ListManagementServersMetricsResponse, error) + NewListManagementServersMetricsParams() *ListManagementServersMetricsParams + GetManagementServersMetricID(name string, opts ...OptionFunc) (string, int, error) + GetManagementServersMetricByName(name string, opts ...OptionFunc) (*ManagementServersMetric, int, error) + GetManagementServersMetricByID(id string, opts ...OptionFunc) (*ManagementServersMetric, int, error) + ListDbMetrics(p *ListDbMetricsParams) (*ListDbMetricsResponse, error) + NewListDbMetricsParams() *ListDbMetricsParams +} + +type ListManagementServersMetricsParams struct { + p map[string]interface{} +} + +func (p *ListManagementServersMetricsParams) toURLValues() url.Values { + u := url.Values{} + if p.p == nil { + return u + } + if v, found := p.p["id"]; found { + u.Set("id", v.(string)) + } + if v, found := p.p["keyword"]; found { + u.Set("keyword", v.(string)) + } + if v, found := p.p["name"]; found { + u.Set("name", v.(string)) + } + if v, found := p.p["page"]; found { + vv := strconv.Itoa(v.(int)) + u.Set("page", vv) + } + if v, found := p.p["pagesize"]; found { + vv := strconv.Itoa(v.(int)) + u.Set("pagesize", vv) + } + if v, found := p.p["system"]; found { + vv := strconv.FormatBool(v.(bool)) + u.Set("system", vv) + } + return u +} + +func (p *ListManagementServersMetricsParams) SetId(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["id"] = v +} + +func (p *ListManagementServersMetricsParams) GetId() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["id"].(string) + return value, ok +} + +func (p *ListManagementServersMetricsParams) SetKeyword(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["keyword"] = v +} + +func (p *ListManagementServersMetricsParams) GetKeyword() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["keyword"].(string) + return value, ok +} + +func (p *ListManagementServersMetricsParams) SetName(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["name"] = v +} + +func (p *ListManagementServersMetricsParams) GetName() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["name"].(string) + return value, ok +} + +func (p *ListManagementServersMetricsParams) SetPage(v int) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["page"] = v +} + +func (p *ListManagementServersMetricsParams) GetPage() (int, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["page"].(int) + return value, ok +} + +func (p *ListManagementServersMetricsParams) SetPagesize(v int) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["pagesize"] = v +} + +func (p *ListManagementServersMetricsParams) GetPagesize() (int, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["pagesize"].(int) + return value, ok +} + +func (p *ListManagementServersMetricsParams) SetSystem(v bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["system"] = v +} + +func (p *ListManagementServersMetricsParams) GetSystem() (bool, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["system"].(bool) + return value, ok +} + +// You should always use this function to get a new ListManagementServersMetricsParams instance, +// as then you are sure you have configured all required params +func (s *InfrastructureUsageService) NewListManagementServersMetricsParams() *ListManagementServersMetricsParams { + p := &ListManagementServersMetricsParams{} + p.p = make(map[string]interface{}) + return p +} + +// This is a courtesy helper function, which in some cases may not work as expected! +func (s *InfrastructureUsageService) GetManagementServersMetricID(name string, opts ...OptionFunc) (string, int, error) { + p := &ListManagementServersMetricsParams{} + p.p = make(map[string]interface{}) + + p.p["name"] = name + + for _, fn := range append(s.cs.options, opts...) { + if err := fn(s.cs, p); err != nil { + return "", -1, err + } + } + + l, err := s.ListManagementServersMetrics(p) + if err != nil { + return "", -1, err + } + + if l.Count == 0 { + return "", l.Count, fmt.Errorf("No match found for %s: %+v", name, l) + } + + if l.Count == 1 { + return l.ManagementServersMetrics[0].Id, l.Count, nil + } + + if l.Count > 1 { + for _, v := range l.ManagementServersMetrics { + if v.Name == name { + return v.Id, l.Count, nil + } + } + } + return "", l.Count, fmt.Errorf("Could not find an exact match for %s: %+v", name, l) +} + +// This is a courtesy helper function, which in some cases may not work as expected! +func (s *InfrastructureUsageService) GetManagementServersMetricByName(name string, opts ...OptionFunc) (*ManagementServersMetric, int, error) { + id, count, err := s.GetManagementServersMetricID(name, opts...) + if err != nil { + return nil, count, err + } + + r, count, err := s.GetManagementServersMetricByID(id, opts...) + if err != nil { + return nil, count, err + } + return r, count, nil +} + +// This is a courtesy helper function, which in some cases may not work as expected! +func (s *InfrastructureUsageService) GetManagementServersMetricByID(id string, opts ...OptionFunc) (*ManagementServersMetric, int, error) { + p := &ListManagementServersMetricsParams{} + p.p = make(map[string]interface{}) + + p.p["id"] = id + + for _, fn := range append(s.cs.options, opts...) { + if err := fn(s.cs, p); err != nil { + return nil, -1, err + } + } + + l, err := s.ListManagementServersMetrics(p) + if err != nil { + if strings.Contains(err.Error(), fmt.Sprintf( + "Invalid parameter id value=%s due to incorrect long value format, "+ + "or entity does not exist", id)) { + return nil, 0, fmt.Errorf("No match found for %s: %+v", id, l) + } + return nil, -1, err + } + + if l.Count == 0 { + return nil, l.Count, fmt.Errorf("No match found for %s: %+v", id, l) + } + + if l.Count == 1 { + return l.ManagementServersMetrics[0], l.Count, nil + } + return nil, l.Count, fmt.Errorf("There is more then one result for ManagementServersMetric UUID: %s!", id) +} + +// Lists Management Server metrics +func (s *InfrastructureUsageService) ListManagementServersMetrics(p *ListManagementServersMetricsParams) (*ListManagementServersMetricsResponse, error) { + resp, err := s.cs.newRequest("listManagementServersMetrics", p.toURLValues()) + if err != nil { + return nil, err + } + + var r ListManagementServersMetricsResponse + if err := json.Unmarshal(resp, &r); err != nil { + return nil, err + } + + return &r, nil +} + +type ListManagementServersMetricsResponse struct { + Count int `json:"count"` + ManagementServersMetrics []*ManagementServersMetric `json:"managementserversmetric"` +} + +type ManagementServersMetric struct { + Agentcount int `json:"agentcount"` + Availableprocessors int `json:"availableprocessors"` + Collectiontime string `json:"collectiontime"` + Cpuload string `json:"cpuload"` + Dbislocal bool `json:"dbislocal"` + Heapmemorytotal int64 `json:"heapmemorytotal"` + Heapmemoryused int64 `json:"heapmemoryused"` + Id string `json:"id"` + Javadistribution string `json:"javadistribution"` + Javaversion string `json:"javaversion"` + JobID string `json:"jobid"` + Jobstatus int `json:"jobstatus"` + Kernelversion string `json:"kernelversion"` + Lastboottime string `json:"lastboottime"` + Lastserverstart string `json:"lastserverstart"` + Lastserverstop string `json:"lastserverstop"` + Loginfo string `json:"loginfo"` + Name string `json:"name"` + Osdistribution string `json:"osdistribution"` + Sessions int64 `json:"sessions"` + State string `json:"state"` + Systemcycleusage string `json:"systemcycleusage"` + Systemloadaverages string `json:"systemloadaverages"` + Systemmemoryfree string `json:"systemmemoryfree"` + Systemmemorytotal string `json:"systemmemorytotal"` + Systemmemoryused string `json:"systemmemoryused"` + Systemmemoryvirtualsize string `json:"systemmemoryvirtualsize"` + Systemtotalcpucycles float64 `json:"systemtotalcpucycles"` + Threadsblockedcount int `json:"threadsblockedcount"` + Threadsdaemoncount int `json:"threadsdaemoncount"` + Threadsrunnablecount int `json:"threadsrunnablecount"` + Threadsteminatedcount int `json:"threadsteminatedcount"` + Threadstotalcount int `json:"threadstotalcount"` + Threadswaitingcount int `json:"threadswaitingcount"` + Usageislocal bool `json:"usageislocal"` + Version string `json:"version"` +} + +type ListDbMetricsParams struct { + p map[string]interface{} +} + +func (p *ListDbMetricsParams) toURLValues() url.Values { + u := url.Values{} + if p.p == nil { + return u + } + return u +} + +// You should always use this function to get a new ListDbMetricsParams instance, +// as then you are sure you have configured all required params +func (s *InfrastructureUsageService) NewListDbMetricsParams() *ListDbMetricsParams { + p := &ListDbMetricsParams{} + p.p = make(map[string]interface{}) + return p +} + +// list the db hosts and statistics +func (s *InfrastructureUsageService) ListDbMetrics(p *ListDbMetricsParams) (*ListDbMetricsResponse, error) { + resp, err := s.cs.newRequest("listDbMetrics", p.toURLValues()) + if err != nil { + return nil, err + } + + var r ListDbMetricsResponse + if err := json.Unmarshal(resp, &r); err != nil { + return nil, err + } + + return &r, nil +} + +type ListDbMetricsResponse struct { + Count int `json:"count"` + DbMetrics []*DbMetric `json:"dbmetric"` +} + +type DbMetric struct { + Collectiontime string `json:"collectiontime"` + Connections int `json:"connections"` + Dbloadaverages string `json:"dbloadaverages"` + Hostname string `json:"hostname"` + JobID string `json:"jobid"` + Jobstatus int `json:"jobstatus"` + Queries int `json:"queries"` + Replicas string `json:"replicas"` + Tlsversions string `json:"tlsversions"` + Uptime int `json:"uptime"` + Version string `json:"version"` + Versioncomment string `json:"versioncomment"` +} diff --git a/cloudstack/InfrastructureUsageService_mock.go b/cloudstack/InfrastructureUsageService_mock.go new file mode 100644 index 0000000..cca2899 --- /dev/null +++ b/cloudstack/InfrastructureUsageService_mock.go @@ -0,0 +1,174 @@ +// +// Licensed to the Apache Software Foundation (ASF) under one +// or more contributor license agreements. See the NOTICE file +// distributed with this work for additional information +// regarding copyright ownership. The ASF licenses this file +// to you under the Apache License, Version 2.0 (the +// "License"); you may not use this file except in compliance +// with the License. You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, +// software distributed under the License is distributed on an +// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +// KIND, either express or implied. See the License for the +// specific language governing permissions and limitations +// under the License. +// + +// Code generated by MockGen. DO NOT EDIT. +// Source: ./cloudstack/InfrastructureUsageService.go + +// Package cloudstack is a generated GoMock package. +package cloudstack + +import ( + reflect "reflect" + + gomock "github.com/golang/mock/gomock" +) + +// MockInfrastructureUsageServiceIface is a mock of InfrastructureUsageServiceIface interface. +type MockInfrastructureUsageServiceIface struct { + ctrl *gomock.Controller + recorder *MockInfrastructureUsageServiceIfaceMockRecorder +} + +// MockInfrastructureUsageServiceIfaceMockRecorder is the mock recorder for MockInfrastructureUsageServiceIface. +type MockInfrastructureUsageServiceIfaceMockRecorder struct { + mock *MockInfrastructureUsageServiceIface +} + +// NewMockInfrastructureUsageServiceIface creates a new mock instance. +func NewMockInfrastructureUsageServiceIface(ctrl *gomock.Controller) *MockInfrastructureUsageServiceIface { + mock := &MockInfrastructureUsageServiceIface{ctrl: ctrl} + mock.recorder = &MockInfrastructureUsageServiceIfaceMockRecorder{mock} + return mock +} + +// EXPECT returns an object that allows the caller to indicate expected use. +func (m *MockInfrastructureUsageServiceIface) EXPECT() *MockInfrastructureUsageServiceIfaceMockRecorder { + return m.recorder +} + +// GetManagementServersMetricByID mocks base method. +func (m *MockInfrastructureUsageServiceIface) GetManagementServersMetricByID(id string, opts ...OptionFunc) (*ManagementServersMetric, int, error) { + m.ctrl.T.Helper() + varargs := []interface{}{id} + for _, a := range opts { + varargs = append(varargs, a) + } + ret := m.ctrl.Call(m, "GetManagementServersMetricByID", varargs...) + ret0, _ := ret[0].(*ManagementServersMetric) + ret1, _ := ret[1].(int) + ret2, _ := ret[2].(error) + return ret0, ret1, ret2 +} + +// GetManagementServersMetricByID indicates an expected call of GetManagementServersMetricByID. +func (mr *MockInfrastructureUsageServiceIfaceMockRecorder) GetManagementServersMetricByID(id interface{}, opts ...interface{}) *gomock.Call { + mr.mock.ctrl.T.Helper() + varargs := append([]interface{}{id}, opts...) + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "GetManagementServersMetricByID", reflect.TypeOf((*MockInfrastructureUsageServiceIface)(nil).GetManagementServersMetricByID), varargs...) +} + +// GetManagementServersMetricByName mocks base method. +func (m *MockInfrastructureUsageServiceIface) GetManagementServersMetricByName(name string, opts ...OptionFunc) (*ManagementServersMetric, int, error) { + m.ctrl.T.Helper() + varargs := []interface{}{name} + for _, a := range opts { + varargs = append(varargs, a) + } + ret := m.ctrl.Call(m, "GetManagementServersMetricByName", varargs...) + ret0, _ := ret[0].(*ManagementServersMetric) + ret1, _ := ret[1].(int) + ret2, _ := ret[2].(error) + return ret0, ret1, ret2 +} + +// GetManagementServersMetricByName indicates an expected call of GetManagementServersMetricByName. +func (mr *MockInfrastructureUsageServiceIfaceMockRecorder) GetManagementServersMetricByName(name interface{}, opts ...interface{}) *gomock.Call { + mr.mock.ctrl.T.Helper() + varargs := append([]interface{}{name}, opts...) + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "GetManagementServersMetricByName", reflect.TypeOf((*MockInfrastructureUsageServiceIface)(nil).GetManagementServersMetricByName), varargs...) +} + +// GetManagementServersMetricID mocks base method. +func (m *MockInfrastructureUsageServiceIface) GetManagementServersMetricID(name string, opts ...OptionFunc) (string, int, error) { + m.ctrl.T.Helper() + varargs := []interface{}{name} + for _, a := range opts { + varargs = append(varargs, a) + } + ret := m.ctrl.Call(m, "GetManagementServersMetricID", varargs...) + ret0, _ := ret[0].(string) + ret1, _ := ret[1].(int) + ret2, _ := ret[2].(error) + return ret0, ret1, ret2 +} + +// GetManagementServersMetricID indicates an expected call of GetManagementServersMetricID. +func (mr *MockInfrastructureUsageServiceIfaceMockRecorder) GetManagementServersMetricID(name interface{}, opts ...interface{}) *gomock.Call { + mr.mock.ctrl.T.Helper() + varargs := append([]interface{}{name}, opts...) + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "GetManagementServersMetricID", reflect.TypeOf((*MockInfrastructureUsageServiceIface)(nil).GetManagementServersMetricID), varargs...) +} + +// ListDbMetrics mocks base method. +func (m *MockInfrastructureUsageServiceIface) ListDbMetrics(p *ListDbMetricsParams) (*ListDbMetricsResponse, error) { + m.ctrl.T.Helper() + ret := m.ctrl.Call(m, "ListDbMetrics", p) + ret0, _ := ret[0].(*ListDbMetricsResponse) + ret1, _ := ret[1].(error) + return ret0, ret1 +} + +// ListDbMetrics indicates an expected call of ListDbMetrics. +func (mr *MockInfrastructureUsageServiceIfaceMockRecorder) ListDbMetrics(p interface{}) *gomock.Call { + mr.mock.ctrl.T.Helper() + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "ListDbMetrics", reflect.TypeOf((*MockInfrastructureUsageServiceIface)(nil).ListDbMetrics), p) +} + +// ListManagementServersMetrics mocks base method. +func (m *MockInfrastructureUsageServiceIface) ListManagementServersMetrics(p *ListManagementServersMetricsParams) (*ListManagementServersMetricsResponse, error) { + m.ctrl.T.Helper() + ret := m.ctrl.Call(m, "ListManagementServersMetrics", p) + ret0, _ := ret[0].(*ListManagementServersMetricsResponse) + ret1, _ := ret[1].(error) + return ret0, ret1 +} + +// ListManagementServersMetrics indicates an expected call of ListManagementServersMetrics. +func (mr *MockInfrastructureUsageServiceIfaceMockRecorder) ListManagementServersMetrics(p interface{}) *gomock.Call { + mr.mock.ctrl.T.Helper() + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "ListManagementServersMetrics", reflect.TypeOf((*MockInfrastructureUsageServiceIface)(nil).ListManagementServersMetrics), p) +} + +// NewListDbMetricsParams mocks base method. +func (m *MockInfrastructureUsageServiceIface) NewListDbMetricsParams() *ListDbMetricsParams { + m.ctrl.T.Helper() + ret := m.ctrl.Call(m, "NewListDbMetricsParams") + ret0, _ := ret[0].(*ListDbMetricsParams) + return ret0 +} + +// NewListDbMetricsParams indicates an expected call of NewListDbMetricsParams. +func (mr *MockInfrastructureUsageServiceIfaceMockRecorder) NewListDbMetricsParams() *gomock.Call { + mr.mock.ctrl.T.Helper() + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "NewListDbMetricsParams", reflect.TypeOf((*MockInfrastructureUsageServiceIface)(nil).NewListDbMetricsParams)) +} + +// NewListManagementServersMetricsParams mocks base method. +func (m *MockInfrastructureUsageServiceIface) NewListManagementServersMetricsParams() *ListManagementServersMetricsParams { + m.ctrl.T.Helper() + ret := m.ctrl.Call(m, "NewListManagementServersMetricsParams") + ret0, _ := ret[0].(*ListManagementServersMetricsParams) + return ret0 +} + +// NewListManagementServersMetricsParams indicates an expected call of NewListManagementServersMetricsParams. +func (mr *MockInfrastructureUsageServiceIfaceMockRecorder) NewListManagementServersMetricsParams() *gomock.Call { + mr.mock.ctrl.T.Helper() + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "NewListManagementServersMetricsParams", reflect.TypeOf((*MockInfrastructureUsageServiceIface)(nil).NewListManagementServersMetricsParams)) +} diff --git a/cloudstack/InternalLBService.go b/cloudstack/InternalLBService.go index 44922d0..d65054d 100644 --- a/cloudstack/InternalLBService.go +++ b/cloudstack/InternalLBService.go @@ -921,6 +921,7 @@ type InternalLoadBalancerVM struct { Scriptsversion string `json:"scriptsversion"` Serviceofferingid string `json:"serviceofferingid"` Serviceofferingname string `json:"serviceofferingname"` + Softwareversion string `json:"softwareversion"` State string `json:"state"` Templateid string `json:"templateid"` Templatename string `json:"templatename"` @@ -1059,6 +1060,7 @@ type StartInternalLoadBalancerVMResponse struct { Scriptsversion string `json:"scriptsversion"` Serviceofferingid string `json:"serviceofferingid"` Serviceofferingname string `json:"serviceofferingname"` + Softwareversion string `json:"softwareversion"` State string `json:"state"` Templateid string `json:"templateid"` Templatename string `json:"templatename"` @@ -1216,6 +1218,7 @@ type StopInternalLoadBalancerVMResponse struct { Scriptsversion string `json:"scriptsversion"` Serviceofferingid string `json:"serviceofferingid"` Serviceofferingname string `json:"serviceofferingname"` + Softwareversion string `json:"softwareversion"` State string `json:"state"` Templateid string `json:"templateid"` Templatename string `json:"templatename"` diff --git a/cloudstack/KubernetesService.go b/cloudstack/KubernetesService.go index ba9a870..07bcd3e 100644 --- a/cloudstack/KubernetesService.go +++ b/cloudstack/KubernetesService.go @@ -231,6 +231,7 @@ func (s *KubernetesService) AddKubernetesSupportedVersion(p *AddKubernetesSuppor } type AddKubernetesSupportedVersionResponse struct { + Created string `json:"created"` Id string `json:"id"` Isoid string `json:"isoid"` Isoname string `json:"isoname"` @@ -644,6 +645,7 @@ type CreateKubernetesClusterResponse struct { Consoleendpoint string `json:"consoleendpoint"` Controlnodes int64 `json:"controlnodes"` Cpunumber string `json:"cpunumber"` + Created string `json:"created"` Description string `json:"description"` Domain string `json:"domain"` Domainid string `json:"domainid"` @@ -1220,6 +1222,7 @@ type KubernetesCluster struct { Consoleendpoint string `json:"consoleendpoint"` Controlnodes int64 `json:"controlnodes"` Cpunumber string `json:"cpunumber"` + Created string `json:"created"` Description string `json:"description"` Domain string `json:"domain"` Domainid string `json:"domainid"` @@ -1503,6 +1506,7 @@ type ListKubernetesSupportedVersionsResponse struct { } type KubernetesSupportedVersion struct { + Created string `json:"created"` Id string `json:"id"` Isoid string `json:"isoid"` Isoname string `json:"isoname"` @@ -1714,6 +1718,7 @@ type ScaleKubernetesClusterResponse struct { Consoleendpoint string `json:"consoleendpoint"` Controlnodes int64 `json:"controlnodes"` Cpunumber string `json:"cpunumber"` + Created string `json:"created"` Description string `json:"description"` Domain string `json:"domain"` Domainid string `json:"domainid"` @@ -1826,6 +1831,7 @@ type StartKubernetesClusterResponse struct { Consoleendpoint string `json:"consoleendpoint"` Controlnodes int64 `json:"controlnodes"` Cpunumber string `json:"cpunumber"` + Created string `json:"created"` Description string `json:"description"` Domain string `json:"domain"` Domainid string `json:"domainid"` @@ -2007,6 +2013,7 @@ func (s *KubernetesService) UpdateKubernetesSupportedVersion(p *UpdateKubernetes } type UpdateKubernetesSupportedVersionResponse struct { + Created string `json:"created"` Id string `json:"id"` Isoid string `json:"isoid"` Isoname string `json:"isoname"` @@ -2124,6 +2131,7 @@ type UpgradeKubernetesClusterResponse struct { Consoleendpoint string `json:"consoleendpoint"` Controlnodes int64 `json:"controlnodes"` Cpunumber string `json:"cpunumber"` + Created string `json:"created"` Description string `json:"description"` Domain string `json:"domain"` Domainid string `json:"domainid"` diff --git a/cloudstack/NetworkACLService.go b/cloudstack/NetworkACLService.go index 41fe2dd..475b1b6 100644 --- a/cloudstack/NetworkACLService.go +++ b/cloudstack/NetworkACLService.go @@ -508,6 +508,7 @@ type CreateNetworkACLListResponse struct { Jobstatus int `json:"jobstatus"` Name string `json:"name"` Vpcid string `json:"vpcid"` + Vpcname string `json:"vpcname"` } type DeleteNetworkACLParams struct { @@ -1032,6 +1033,7 @@ type NetworkACLList struct { Jobstatus int `json:"jobstatus"` Name string `json:"name"` Vpcid string `json:"vpcid"` + Vpcname string `json:"vpcname"` } type ListNetworkACLsParams struct { diff --git a/cloudstack/NetworkOfferingService.go b/cloudstack/NetworkOfferingService.go index 7ae5bff..932b11d 100644 --- a/cloudstack/NetworkOfferingService.go +++ b/cloudstack/NetworkOfferingService.go @@ -85,6 +85,9 @@ func (p *CreateNetworkOfferingParams) toURLValues() url.Values { if v, found := p.p["guestiptype"]; found { u.Set("guestiptype", v.(string)) } + if v, found := p.p["internetprotocol"]; found { + u.Set("internetprotocol", v.(string)) + } if v, found := p.p["ispersistent"]; found { vv := strconv.FormatBool(v.(bool)) u.Set("ispersistent", vv) @@ -281,6 +284,21 @@ func (p *CreateNetworkOfferingParams) GetGuestiptype() (string, bool) { return value, ok } +func (p *CreateNetworkOfferingParams) SetInternetprotocol(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["internetprotocol"] = v +} + +func (p *CreateNetworkOfferingParams) GetInternetprotocol() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["internetprotocol"].(string) + return value, ok +} + func (p *CreateNetworkOfferingParams) SetIspersistent(v bool) { if p.p == nil { p.p = make(map[string]interface{}) @@ -535,6 +553,7 @@ type CreateNetworkOfferingResponse struct { Guestiptype string `json:"guestiptype"` Hasannotations bool `json:"hasannotations"` Id string `json:"id"` + Internetprotocol string `json:"internetprotocol"` Isdefault bool `json:"isdefault"` Ispersistent bool `json:"ispersistent"` JobID string `json:"jobid"` @@ -1188,6 +1207,7 @@ type NetworkOffering struct { Guestiptype string `json:"guestiptype"` Hasannotations bool `json:"hasannotations"` Id string `json:"id"` + Internetprotocol string `json:"internetprotocol"` Isdefault bool `json:"isdefault"` Ispersistent bool `json:"ispersistent"` JobID string `json:"jobid"` @@ -1483,6 +1503,7 @@ type UpdateNetworkOfferingResponse struct { Guestiptype string `json:"guestiptype"` Hasannotations bool `json:"hasannotations"` Id string `json:"id"` + Internetprotocol string `json:"internetprotocol"` Isdefault bool `json:"isdefault"` Ispersistent bool `json:"ispersistent"` JobID string `json:"jobid"` diff --git a/cloudstack/NetworkService.go b/cloudstack/NetworkService.go index 7eac43b..ca8a005 100644 --- a/cloudstack/NetworkService.go +++ b/cloudstack/NetworkService.go @@ -96,6 +96,21 @@ type NetworkServiceIface interface { NewUpdatePhysicalNetworkParams(id string) *UpdatePhysicalNetworkParams UpdateStorageNetworkIpRange(p *UpdateStorageNetworkIpRangeParams) (*UpdateStorageNetworkIpRangeResponse, error) NewUpdateStorageNetworkIpRangeParams(id string) *UpdateStorageNetworkIpRangeParams + DeleteGuestNetworkIpv6Prefix(p *DeleteGuestNetworkIpv6PrefixParams) (*DeleteGuestNetworkIpv6PrefixResponse, error) + NewDeleteGuestNetworkIpv6PrefixParams(id string) *DeleteGuestNetworkIpv6PrefixParams + CreateGuestNetworkIpv6Prefix(p *CreateGuestNetworkIpv6PrefixParams) (*CreateGuestNetworkIpv6PrefixResponse, error) + NewCreateGuestNetworkIpv6PrefixParams(prefix string, zoneid string) *CreateGuestNetworkIpv6PrefixParams + ListGuestNetworkIpv6Prefixes(p *ListGuestNetworkIpv6PrefixesParams) (*ListGuestNetworkIpv6PrefixesResponse, error) + NewListGuestNetworkIpv6PrefixesParams() *ListGuestNetworkIpv6PrefixesParams + GetGuestNetworkIpv6PrefixeByID(id string, opts ...OptionFunc) (*GuestNetworkIpv6Prefixe, int, error) + CreateNetworkPermissions(p *CreateNetworkPermissionsParams) (*CreateNetworkPermissionsResponse, error) + NewCreateNetworkPermissionsParams(networkid string) *CreateNetworkPermissionsParams + ResetNetworkPermissions(p *ResetNetworkPermissionsParams) (*ResetNetworkPermissionsResponse, error) + NewResetNetworkPermissionsParams(networkid string) *ResetNetworkPermissionsParams + ListNetworkPermissions(p *ListNetworkPermissionsParams) (*ListNetworkPermissionsResponse, error) + NewListNetworkPermissionsParams(networkid string) *ListNetworkPermissionsParams + RemoveNetworkPermissions(p *RemoveNetworkPermissionsParams) (*RemoveNetworkPermissionsResponse, error) + NewRemoveNetworkPermissionsParams(networkid string) *RemoveNetworkPermissionsParams } type AddNetworkServiceProviderParams struct { @@ -399,6 +414,9 @@ func (p *CreateNetworkParams) toURLValues() url.Values { if v, found := p.p["acltype"]; found { u.Set("acltype", v.(string)) } + if v, found := p.p["associatednetworkid"]; found { + u.Set("associatednetworkid", v.(string)) + } if v, found := p.p["bypassvlanoverlapcheck"]; found { vv := strconv.FormatBool(v.(bool)) u.Set("bypassvlanoverlapcheck", vv) @@ -532,6 +550,21 @@ func (p *CreateNetworkParams) GetAcltype() (string, bool) { return value, ok } +func (p *CreateNetworkParams) SetAssociatednetworkid(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["associatednetworkid"] = v +} + +func (p *CreateNetworkParams) GetAssociatednetworkid() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["associatednetworkid"].(string) + return value, ok +} + func (p *CreateNetworkParams) SetBypassvlanoverlapcheck(v bool) { if p.p == nil { p.p = make(map[string]interface{}) @@ -973,6 +1006,8 @@ type CreateNetworkResponse struct { Aclid string `json:"aclid"` Aclname string `json:"aclname"` Acltype string `json:"acltype"` + Associatednetwork string `json:"associatednetwork"` + Associatednetworkid string `json:"associatednetworkid"` Broadcastdomaintype string `json:"broadcastdomaintype"` Broadcasturi string `json:"broadcasturi"` Canusefordeploy bool `json:"canusefordeploy"` @@ -985,13 +1020,17 @@ type CreateNetworkResponse struct { Dns2 string `json:"dns2"` Domain string `json:"domain"` Domainid string `json:"domainid"` + Egressdefaultpolicy bool `json:"egressdefaultpolicy"` Externalid string `json:"externalid"` Gateway string `json:"gateway"` Hasannotations bool `json:"hasannotations"` Icon interface{} `json:"icon"` Id string `json:"id"` + Internetprotocol string `json:"internetprotocol"` Ip6cidr string `json:"ip6cidr"` Ip6gateway string `json:"ip6gateway"` + Ip6routes []interface{} `json:"ip6routes"` + Ip6routing string `json:"ip6routing"` Isdefault bool `json:"isdefault"` Ispersistent bool `json:"ispersistent"` Issystem bool `json:"issystem"` @@ -1801,6 +1840,7 @@ func (s *NetworkService) DedicatePublicIpRange(p *DedicatePublicIpRangeParams) ( type DedicatePublicIpRangeResponse struct { Account string `json:"account"` + Cidr string `json:"cidr"` Description string `json:"description"` Domain string `json:"domain"` Domainid string `json:"domainid"` @@ -2391,6 +2431,8 @@ type NetscalerLoadBalancerNetwork struct { Aclid string `json:"aclid"` Aclname string `json:"aclname"` Acltype string `json:"acltype"` + Associatednetwork string `json:"associatednetwork"` + Associatednetworkid string `json:"associatednetworkid"` Broadcastdomaintype string `json:"broadcastdomaintype"` Broadcasturi string `json:"broadcasturi"` Canusefordeploy bool `json:"canusefordeploy"` @@ -2403,13 +2445,17 @@ type NetscalerLoadBalancerNetwork struct { Dns2 string `json:"dns2"` Domain string `json:"domain"` Domainid string `json:"domainid"` + Egressdefaultpolicy bool `json:"egressdefaultpolicy"` Externalid string `json:"externalid"` Gateway string `json:"gateway"` Hasannotations bool `json:"hasannotations"` Icon interface{} `json:"icon"` Id string `json:"id"` + Internetprotocol string `json:"internetprotocol"` Ip6cidr string `json:"ip6cidr"` Ip6gateway string `json:"ip6gateway"` + Ip6routes []interface{} `json:"ip6routes"` + Ip6routing string `json:"ip6routing"` Isdefault bool `json:"isdefault"` Ispersistent bool `json:"ispersistent"` Issystem bool `json:"issystem"` @@ -2786,6 +2832,9 @@ func (p *ListNetworksParams) toURLValues() url.Values { if v, found := p.p["acltype"]; found { u.Set("acltype", v.(string)) } + if v, found := p.p["associatednetworkid"]; found { + u.Set("associatednetworkid", v.(string)) + } if v, found := p.p["canusefordeploy"]; found { vv := strconv.FormatBool(v.(bool)) u.Set("canusefordeploy", vv) @@ -2819,6 +2868,9 @@ func (p *ListNetworksParams) toURLValues() url.Values { vv := strconv.FormatBool(v.(bool)) u.Set("listall", vv) } + if v, found := p.p["networkfilter"]; found { + u.Set("networkfilter", v.(string)) + } if v, found := p.p["networkofferingid"]; found { u.Set("networkofferingid", v.(string)) } @@ -2865,6 +2917,9 @@ func (p *ListNetworksParams) toURLValues() url.Values { if v, found := p.p["type"]; found { u.Set("type", v.(string)) } + if v, found := p.p["vlan"]; found { + u.Set("vlan", v.(string)) + } if v, found := p.p["vpcid"]; found { u.Set("vpcid", v.(string)) } @@ -2904,6 +2959,21 @@ func (p *ListNetworksParams) GetAcltype() (string, bool) { return value, ok } +func (p *ListNetworksParams) SetAssociatednetworkid(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["associatednetworkid"] = v +} + +func (p *ListNetworksParams) GetAssociatednetworkid() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["associatednetworkid"].(string) + return value, ok +} + func (p *ListNetworksParams) SetCanusefordeploy(v bool) { if p.p == nil { p.p = make(map[string]interface{}) @@ -3039,6 +3109,21 @@ func (p *ListNetworksParams) GetListall() (bool, bool) { return value, ok } +func (p *ListNetworksParams) SetNetworkfilter(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["networkfilter"] = v +} + +func (p *ListNetworksParams) GetNetworkfilter() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["networkfilter"].(string) + return value, ok +} + func (p *ListNetworksParams) SetNetworkofferingid(v string) { if p.p == nil { p.p = make(map[string]interface{}) @@ -3219,6 +3304,21 @@ func (p *ListNetworksParams) GetType() (string, bool) { return value, ok } +func (p *ListNetworksParams) SetVlan(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["vlan"] = v +} + +func (p *ListNetworksParams) GetVlan() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["vlan"].(string) + return value, ok +} + func (p *ListNetworksParams) SetVpcid(v string) { if p.p == nil { p.p = make(map[string]interface{}) @@ -3365,6 +3465,8 @@ type Network struct { Aclid string `json:"aclid"` Aclname string `json:"aclname"` Acltype string `json:"acltype"` + Associatednetwork string `json:"associatednetwork"` + Associatednetworkid string `json:"associatednetworkid"` Broadcastdomaintype string `json:"broadcastdomaintype"` Broadcasturi string `json:"broadcasturi"` Canusefordeploy bool `json:"canusefordeploy"` @@ -3377,13 +3479,17 @@ type Network struct { Dns2 string `json:"dns2"` Domain string `json:"domain"` Domainid string `json:"domainid"` + Egressdefaultpolicy bool `json:"egressdefaultpolicy"` Externalid string `json:"externalid"` Gateway string `json:"gateway"` Hasannotations bool `json:"hasannotations"` Icon interface{} `json:"icon"` Id string `json:"id"` + Internetprotocol string `json:"internetprotocol"` Ip6cidr string `json:"ip6cidr"` Ip6gateway string `json:"ip6gateway"` + Ip6routes []interface{} `json:"ip6routes"` + Ip6routing string `json:"ip6routing"` Isdefault bool `json:"isdefault"` Ispersistent bool `json:"ispersistent"` Issystem bool `json:"issystem"` @@ -3602,6 +3708,8 @@ type NiciraNvpDeviceNetwork struct { Aclid string `json:"aclid"` Aclname string `json:"aclname"` Acltype string `json:"acltype"` + Associatednetwork string `json:"associatednetwork"` + Associatednetworkid string `json:"associatednetworkid"` Broadcastdomaintype string `json:"broadcastdomaintype"` Broadcasturi string `json:"broadcasturi"` Canusefordeploy bool `json:"canusefordeploy"` @@ -3614,13 +3722,17 @@ type NiciraNvpDeviceNetwork struct { Dns2 string `json:"dns2"` Domain string `json:"domain"` Domainid string `json:"domainid"` + Egressdefaultpolicy bool `json:"egressdefaultpolicy"` Externalid string `json:"externalid"` Gateway string `json:"gateway"` Hasannotations bool `json:"hasannotations"` Icon interface{} `json:"icon"` Id string `json:"id"` + Internetprotocol string `json:"internetprotocol"` Ip6cidr string `json:"ip6cidr"` Ip6gateway string `json:"ip6gateway"` + Ip6routes []interface{} `json:"ip6routes"` + Ip6routing string `json:"ip6routing"` Isdefault bool `json:"isdefault"` Ispersistent bool `json:"ispersistent"` Issystem bool `json:"issystem"` @@ -3958,6 +4070,8 @@ type PaloAltoFirewallNetwork struct { Aclid string `json:"aclid"` Aclname string `json:"aclname"` Acltype string `json:"acltype"` + Associatednetwork string `json:"associatednetwork"` + Associatednetworkid string `json:"associatednetworkid"` Broadcastdomaintype string `json:"broadcastdomaintype"` Broadcasturi string `json:"broadcasturi"` Canusefordeploy bool `json:"canusefordeploy"` @@ -3970,13 +4084,17 @@ type PaloAltoFirewallNetwork struct { Dns2 string `json:"dns2"` Domain string `json:"domain"` Domainid string `json:"domainid"` + Egressdefaultpolicy bool `json:"egressdefaultpolicy"` Externalid string `json:"externalid"` Gateway string `json:"gateway"` Hasannotations bool `json:"hasannotations"` Icon interface{} `json:"icon"` Id string `json:"id"` + Internetprotocol string `json:"internetprotocol"` Ip6cidr string `json:"ip6cidr"` Ip6gateway string `json:"ip6gateway"` + Ip6routes []interface{} `json:"ip6routes"` + Ip6routing string `json:"ip6routing"` Isdefault bool `json:"isdefault"` Ispersistent bool `json:"ispersistent"` Issystem bool `json:"issystem"` @@ -4744,6 +4862,10 @@ func (p *RestartNetworkParams) toURLValues() url.Values { if v, found := p.p["id"]; found { u.Set("id", v.(string)) } + if v, found := p.p["livepatch"]; found { + vv := strconv.FormatBool(v.(bool)) + u.Set("livepatch", vv) + } if v, found := p.p["makeredundant"]; found { vv := strconv.FormatBool(v.(bool)) u.Set("makeredundant", vv) @@ -4781,6 +4903,21 @@ func (p *RestartNetworkParams) GetId() (string, bool) { return value, ok } +func (p *RestartNetworkParams) SetLivepatch(v bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["livepatch"] = v +} + +func (p *RestartNetworkParams) GetLivepatch() (bool, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["livepatch"].(bool) + return value, ok +} + func (p *RestartNetworkParams) SetMakeredundant(v bool) { if p.p == nil { p.p = make(map[string]interface{}) @@ -5124,6 +5261,8 @@ type UpdateNetworkResponse struct { Aclid string `json:"aclid"` Aclname string `json:"aclname"` Acltype string `json:"acltype"` + Associatednetwork string `json:"associatednetwork"` + Associatednetworkid string `json:"associatednetworkid"` Broadcastdomaintype string `json:"broadcastdomaintype"` Broadcasturi string `json:"broadcasturi"` Canusefordeploy bool `json:"canusefordeploy"` @@ -5136,13 +5275,17 @@ type UpdateNetworkResponse struct { Dns2 string `json:"dns2"` Domain string `json:"domain"` Domainid string `json:"domainid"` + Egressdefaultpolicy bool `json:"egressdefaultpolicy"` Externalid string `json:"externalid"` Gateway string `json:"gateway"` Hasannotations bool `json:"hasannotations"` Icon interface{} `json:"icon"` Id string `json:"id"` + Internetprotocol string `json:"internetprotocol"` Ip6cidr string `json:"ip6cidr"` Ip6gateway string `json:"ip6gateway"` + Ip6routes []interface{} `json:"ip6routes"` + Ip6routing string `json:"ip6routing"` Isdefault bool `json:"isdefault"` Ispersistent bool `json:"ispersistent"` Issystem bool `json:"issystem"` @@ -5650,3 +5793,810 @@ type UpdateStorageNetworkIpRangeResponse struct { Vlan int `json:"vlan"` Zoneid string `json:"zoneid"` } + +type DeleteGuestNetworkIpv6PrefixParams struct { + p map[string]interface{} +} + +func (p *DeleteGuestNetworkIpv6PrefixParams) toURLValues() url.Values { + u := url.Values{} + if p.p == nil { + return u + } + if v, found := p.p["id"]; found { + u.Set("id", v.(string)) + } + return u +} + +func (p *DeleteGuestNetworkIpv6PrefixParams) SetId(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["id"] = v +} + +func (p *DeleteGuestNetworkIpv6PrefixParams) GetId() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["id"].(string) + return value, ok +} + +// You should always use this function to get a new DeleteGuestNetworkIpv6PrefixParams instance, +// as then you are sure you have configured all required params +func (s *NetworkService) NewDeleteGuestNetworkIpv6PrefixParams(id string) *DeleteGuestNetworkIpv6PrefixParams { + p := &DeleteGuestNetworkIpv6PrefixParams{} + p.p = make(map[string]interface{}) + p.p["id"] = id + return p +} + +// Deletes an existing guest network IPv6 prefix. +func (s *NetworkService) DeleteGuestNetworkIpv6Prefix(p *DeleteGuestNetworkIpv6PrefixParams) (*DeleteGuestNetworkIpv6PrefixResponse, error) { + resp, err := s.cs.newRequest("deleteGuestNetworkIpv6Prefix", p.toURLValues()) + if err != nil { + return nil, err + } + + var r DeleteGuestNetworkIpv6PrefixResponse + if err := json.Unmarshal(resp, &r); err != nil { + return nil, err + } + + // If we have a async client, we need to wait for the async result + if s.cs.async { + b, err := s.cs.GetAsyncJobResult(r.JobID, s.cs.timeout) + if err != nil { + if err == AsyncTimeoutErr { + return &r, err + } + return nil, err + } + + if err := json.Unmarshal(b, &r); err != nil { + return nil, err + } + } + + return &r, nil +} + +type DeleteGuestNetworkIpv6PrefixResponse struct { + Displaytext string `json:"displaytext"` + JobID string `json:"jobid"` + Jobstatus int `json:"jobstatus"` + Success bool `json:"success"` +} + +type CreateGuestNetworkIpv6PrefixParams struct { + p map[string]interface{} +} + +func (p *CreateGuestNetworkIpv6PrefixParams) toURLValues() url.Values { + u := url.Values{} + if p.p == nil { + return u + } + if v, found := p.p["prefix"]; found { + u.Set("prefix", v.(string)) + } + if v, found := p.p["zoneid"]; found { + u.Set("zoneid", v.(string)) + } + return u +} + +func (p *CreateGuestNetworkIpv6PrefixParams) SetPrefix(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["prefix"] = v +} + +func (p *CreateGuestNetworkIpv6PrefixParams) GetPrefix() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["prefix"].(string) + return value, ok +} + +func (p *CreateGuestNetworkIpv6PrefixParams) SetZoneid(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["zoneid"] = v +} + +func (p *CreateGuestNetworkIpv6PrefixParams) 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 CreateGuestNetworkIpv6PrefixParams instance, +// as then you are sure you have configured all required params +func (s *NetworkService) NewCreateGuestNetworkIpv6PrefixParams(prefix string, zoneid string) *CreateGuestNetworkIpv6PrefixParams { + p := &CreateGuestNetworkIpv6PrefixParams{} + p.p = make(map[string]interface{}) + p.p["prefix"] = prefix + p.p["zoneid"] = zoneid + return p +} + +// Creates a guest network IPv6 prefix. +func (s *NetworkService) CreateGuestNetworkIpv6Prefix(p *CreateGuestNetworkIpv6PrefixParams) (*CreateGuestNetworkIpv6PrefixResponse, error) { + resp, err := s.cs.newRequest("createGuestNetworkIpv6Prefix", p.toURLValues()) + if err != nil { + return nil, err + } + + var r CreateGuestNetworkIpv6PrefixResponse + if err := json.Unmarshal(resp, &r); err != nil { + return nil, err + } + + // If we have a async client, we need to wait for the async result + if s.cs.async { + b, err := s.cs.GetAsyncJobResult(r.JobID, s.cs.timeout) + if err != nil { + if err == AsyncTimeoutErr { + return &r, err + } + return nil, err + } + + b, err = getRawValue(b) + if err != nil { + return nil, err + } + + if err := json.Unmarshal(b, &r); err != nil { + return nil, err + } + } + + return &r, nil +} + +type CreateGuestNetworkIpv6PrefixResponse struct { + Availablesubnets int `json:"availablesubnets"` + Created string `json:"created"` + Id string `json:"id"` + JobID string `json:"jobid"` + Jobstatus int `json:"jobstatus"` + Prefix string `json:"prefix"` + Totalsubnets int `json:"totalsubnets"` + Usedsubnets int `json:"usedsubnets"` + Zoneid string `json:"zoneid"` +} + +type ListGuestNetworkIpv6PrefixesParams struct { + p map[string]interface{} +} + +func (p *ListGuestNetworkIpv6PrefixesParams) toURLValues() url.Values { + u := url.Values{} + if p.p == nil { + return u + } + if v, found := p.p["id"]; found { + u.Set("id", v.(string)) + } + if v, found := p.p["keyword"]; found { + u.Set("keyword", v.(string)) + } + if v, found := p.p["page"]; found { + vv := strconv.Itoa(v.(int)) + u.Set("page", vv) + } + if v, found := p.p["pagesize"]; found { + vv := strconv.Itoa(v.(int)) + u.Set("pagesize", vv) + } + if v, found := p.p["zoneid"]; found { + u.Set("zoneid", v.(string)) + } + return u +} + +func (p *ListGuestNetworkIpv6PrefixesParams) SetId(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["id"] = v +} + +func (p *ListGuestNetworkIpv6PrefixesParams) GetId() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["id"].(string) + return value, ok +} + +func (p *ListGuestNetworkIpv6PrefixesParams) SetKeyword(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["keyword"] = v +} + +func (p *ListGuestNetworkIpv6PrefixesParams) GetKeyword() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["keyword"].(string) + return value, ok +} + +func (p *ListGuestNetworkIpv6PrefixesParams) SetPage(v int) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["page"] = v +} + +func (p *ListGuestNetworkIpv6PrefixesParams) GetPage() (int, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["page"].(int) + return value, ok +} + +func (p *ListGuestNetworkIpv6PrefixesParams) SetPagesize(v int) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["pagesize"] = v +} + +func (p *ListGuestNetworkIpv6PrefixesParams) GetPagesize() (int, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["pagesize"].(int) + return value, ok +} + +func (p *ListGuestNetworkIpv6PrefixesParams) SetZoneid(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["zoneid"] = v +} + +func (p *ListGuestNetworkIpv6PrefixesParams) 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 ListGuestNetworkIpv6PrefixesParams instance, +// as then you are sure you have configured all required params +func (s *NetworkService) NewListGuestNetworkIpv6PrefixesParams() *ListGuestNetworkIpv6PrefixesParams { + p := &ListGuestNetworkIpv6PrefixesParams{} + p.p = make(map[string]interface{}) + return p +} + +// This is a courtesy helper function, which in some cases may not work as expected! +func (s *NetworkService) GetGuestNetworkIpv6PrefixeByID(id string, opts ...OptionFunc) (*GuestNetworkIpv6Prefixe, int, error) { + p := &ListGuestNetworkIpv6PrefixesParams{} + p.p = make(map[string]interface{}) + + p.p["id"] = id + + for _, fn := range append(s.cs.options, opts...) { + if err := fn(s.cs, p); err != nil { + return nil, -1, err + } + } + + l, err := s.ListGuestNetworkIpv6Prefixes(p) + if err != nil { + if strings.Contains(err.Error(), fmt.Sprintf( + "Invalid parameter id value=%s due to incorrect long value format, "+ + "or entity does not exist", id)) { + return nil, 0, fmt.Errorf("No match found for %s: %+v", id, l) + } + return nil, -1, err + } + + if l.Count == 0 { + return nil, l.Count, fmt.Errorf("No match found for %s: %+v", id, l) + } + + if l.Count == 1 { + return l.GuestNetworkIpv6Prefixes[0], l.Count, nil + } + return nil, l.Count, fmt.Errorf("There is more then one result for GuestNetworkIpv6Prefixe UUID: %s!", id) +} + +// Lists guest network IPv6 prefixes +func (s *NetworkService) ListGuestNetworkIpv6Prefixes(p *ListGuestNetworkIpv6PrefixesParams) (*ListGuestNetworkIpv6PrefixesResponse, error) { + resp, err := s.cs.newRequest("listGuestNetworkIpv6Prefixes", p.toURLValues()) + if err != nil { + return nil, err + } + + var r ListGuestNetworkIpv6PrefixesResponse + if err := json.Unmarshal(resp, &r); err != nil { + return nil, err + } + + return &r, nil +} + +type ListGuestNetworkIpv6PrefixesResponse struct { + Count int `json:"count"` + GuestNetworkIpv6Prefixes []*GuestNetworkIpv6Prefixe `json:"guestnetworkipv6prefixe"` +} + +type GuestNetworkIpv6Prefixe struct { + Availablesubnets int `json:"availablesubnets"` + Created string `json:"created"` + Id string `json:"id"` + JobID string `json:"jobid"` + Jobstatus int `json:"jobstatus"` + Prefix string `json:"prefix"` + Totalsubnets int `json:"totalsubnets"` + Usedsubnets int `json:"usedsubnets"` + Zoneid string `json:"zoneid"` +} + +type CreateNetworkPermissionsParams struct { + p map[string]interface{} +} + +func (p *CreateNetworkPermissionsParams) toURLValues() url.Values { + u := url.Values{} + if p.p == nil { + return u + } + if v, found := p.p["accountids"]; found { + vv := strings.Join(v.([]string), ",") + u.Set("accountids", vv) + } + if v, found := p.p["accounts"]; found { + vv := strings.Join(v.([]string), ",") + u.Set("accounts", vv) + } + if v, found := p.p["networkid"]; found { + u.Set("networkid", v.(string)) + } + if v, found := p.p["projectids"]; found { + vv := strings.Join(v.([]string), ",") + u.Set("projectids", vv) + } + return u +} + +func (p *CreateNetworkPermissionsParams) SetAccountids(v []string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["accountids"] = v +} + +func (p *CreateNetworkPermissionsParams) GetAccountids() ([]string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["accountids"].([]string) + return value, ok +} + +func (p *CreateNetworkPermissionsParams) SetAccounts(v []string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["accounts"] = v +} + +func (p *CreateNetworkPermissionsParams) GetAccounts() ([]string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["accounts"].([]string) + return value, ok +} + +func (p *CreateNetworkPermissionsParams) SetNetworkid(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["networkid"] = v +} + +func (p *CreateNetworkPermissionsParams) GetNetworkid() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["networkid"].(string) + return value, ok +} + +func (p *CreateNetworkPermissionsParams) SetProjectids(v []string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["projectids"] = v +} + +func (p *CreateNetworkPermissionsParams) GetProjectids() ([]string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["projectids"].([]string) + return value, ok +} + +// You should always use this function to get a new CreateNetworkPermissionsParams instance, +// as then you are sure you have configured all required params +func (s *NetworkService) NewCreateNetworkPermissionsParams(networkid string) *CreateNetworkPermissionsParams { + p := &CreateNetworkPermissionsParams{} + p.p = make(map[string]interface{}) + p.p["networkid"] = networkid + return p +} + +// Updates network permissions. +func (s *NetworkService) CreateNetworkPermissions(p *CreateNetworkPermissionsParams) (*CreateNetworkPermissionsResponse, error) { + resp, err := s.cs.newRequest("createNetworkPermissions", p.toURLValues()) + if err != nil { + return nil, err + } + + var r CreateNetworkPermissionsResponse + if err := json.Unmarshal(resp, &r); err != nil { + return nil, err + } + + return &r, nil +} + +type CreateNetworkPermissionsResponse struct { + Displaytext string `json:"displaytext"` + JobID string `json:"jobid"` + Jobstatus int `json:"jobstatus"` + Success bool `json:"success"` +} + +func (r *CreateNetworkPermissionsResponse) UnmarshalJSON(b []byte) error { + var m map[string]interface{} + err := json.Unmarshal(b, &m) + if err != nil { + return err + } + + if success, ok := m["success"].(string); ok { + m["success"] = success == "true" + b, err = json.Marshal(m) + if err != nil { + return err + } + } + + if ostypeid, ok := m["ostypeid"].(float64); ok { + m["ostypeid"] = strconv.Itoa(int(ostypeid)) + b, err = json.Marshal(m) + if err != nil { + return err + } + } + + type alias CreateNetworkPermissionsResponse + return json.Unmarshal(b, (*alias)(r)) +} + +type ResetNetworkPermissionsParams struct { + p map[string]interface{} +} + +func (p *ResetNetworkPermissionsParams) toURLValues() url.Values { + u := url.Values{} + if p.p == nil { + return u + } + if v, found := p.p["networkid"]; found { + u.Set("networkid", v.(string)) + } + return u +} + +func (p *ResetNetworkPermissionsParams) SetNetworkid(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["networkid"] = v +} + +func (p *ResetNetworkPermissionsParams) GetNetworkid() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["networkid"].(string) + return value, ok +} + +// You should always use this function to get a new ResetNetworkPermissionsParams instance, +// as then you are sure you have configured all required params +func (s *NetworkService) NewResetNetworkPermissionsParams(networkid string) *ResetNetworkPermissionsParams { + p := &ResetNetworkPermissionsParams{} + p.p = make(map[string]interface{}) + p.p["networkid"] = networkid + return p +} + +// Resets network permissions. +func (s *NetworkService) ResetNetworkPermissions(p *ResetNetworkPermissionsParams) (*ResetNetworkPermissionsResponse, error) { + resp, err := s.cs.newRequest("resetNetworkPermissions", p.toURLValues()) + if err != nil { + return nil, err + } + + var r ResetNetworkPermissionsResponse + if err := json.Unmarshal(resp, &r); err != nil { + return nil, err + } + + return &r, nil +} + +type ResetNetworkPermissionsResponse struct { + Displaytext string `json:"displaytext"` + JobID string `json:"jobid"` + Jobstatus int `json:"jobstatus"` + Success bool `json:"success"` +} + +func (r *ResetNetworkPermissionsResponse) UnmarshalJSON(b []byte) error { + var m map[string]interface{} + err := json.Unmarshal(b, &m) + if err != nil { + return err + } + + if success, ok := m["success"].(string); ok { + m["success"] = success == "true" + b, err = json.Marshal(m) + if err != nil { + return err + } + } + + if ostypeid, ok := m["ostypeid"].(float64); ok { + m["ostypeid"] = strconv.Itoa(int(ostypeid)) + b, err = json.Marshal(m) + if err != nil { + return err + } + } + + type alias ResetNetworkPermissionsResponse + return json.Unmarshal(b, (*alias)(r)) +} + +type ListNetworkPermissionsParams struct { + p map[string]interface{} +} + +func (p *ListNetworkPermissionsParams) toURLValues() url.Values { + u := url.Values{} + if p.p == nil { + return u + } + if v, found := p.p["networkid"]; found { + u.Set("networkid", v.(string)) + } + return u +} + +func (p *ListNetworkPermissionsParams) SetNetworkid(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["networkid"] = v +} + +func (p *ListNetworkPermissionsParams) GetNetworkid() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["networkid"].(string) + return value, ok +} + +// You should always use this function to get a new ListNetworkPermissionsParams instance, +// as then you are sure you have configured all required params +func (s *NetworkService) NewListNetworkPermissionsParams(networkid string) *ListNetworkPermissionsParams { + p := &ListNetworkPermissionsParams{} + p.p = make(map[string]interface{}) + p.p["networkid"] = networkid + return p +} + +// List network visibility and all accounts that have permissions to view this network. +func (s *NetworkService) ListNetworkPermissions(p *ListNetworkPermissionsParams) (*ListNetworkPermissionsResponse, error) { + resp, err := s.cs.newRequest("listNetworkPermissions", p.toURLValues()) + if err != nil { + return nil, err + } + + var r ListNetworkPermissionsResponse + if err := json.Unmarshal(resp, &r); err != nil { + return nil, err + } + + return &r, nil +} + +type ListNetworkPermissionsResponse struct { + Count int `json:"count"` + NetworkPermissions []*NetworkPermission `json:"networkpermission"` +} + +type NetworkPermission struct { + Account string `json:"account"` + Accountid string `json:"accountid"` + Domain string `json:"domain"` + Domainid string `json:"domainid"` + JobID string `json:"jobid"` + Jobstatus int `json:"jobstatus"` + Networkid string `json:"networkid"` + Project string `json:"project"` + Projectid string `json:"projectid"` +} + +type RemoveNetworkPermissionsParams struct { + p map[string]interface{} +} + +func (p *RemoveNetworkPermissionsParams) toURLValues() url.Values { + u := url.Values{} + if p.p == nil { + return u + } + if v, found := p.p["accountids"]; found { + vv := strings.Join(v.([]string), ",") + u.Set("accountids", vv) + } + if v, found := p.p["accounts"]; found { + vv := strings.Join(v.([]string), ",") + u.Set("accounts", vv) + } + if v, found := p.p["networkid"]; found { + u.Set("networkid", v.(string)) + } + if v, found := p.p["projectids"]; found { + vv := strings.Join(v.([]string), ",") + u.Set("projectids", vv) + } + return u +} + +func (p *RemoveNetworkPermissionsParams) SetAccountids(v []string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["accountids"] = v +} + +func (p *RemoveNetworkPermissionsParams) GetAccountids() ([]string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["accountids"].([]string) + return value, ok +} + +func (p *RemoveNetworkPermissionsParams) SetAccounts(v []string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["accounts"] = v +} + +func (p *RemoveNetworkPermissionsParams) GetAccounts() ([]string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["accounts"].([]string) + return value, ok +} + +func (p *RemoveNetworkPermissionsParams) SetNetworkid(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["networkid"] = v +} + +func (p *RemoveNetworkPermissionsParams) GetNetworkid() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["networkid"].(string) + return value, ok +} + +func (p *RemoveNetworkPermissionsParams) SetProjectids(v []string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["projectids"] = v +} + +func (p *RemoveNetworkPermissionsParams) GetProjectids() ([]string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["projectids"].([]string) + return value, ok +} + +// You should always use this function to get a new RemoveNetworkPermissionsParams instance, +// as then you are sure you have configured all required params +func (s *NetworkService) NewRemoveNetworkPermissionsParams(networkid string) *RemoveNetworkPermissionsParams { + p := &RemoveNetworkPermissionsParams{} + p.p = make(map[string]interface{}) + p.p["networkid"] = networkid + return p +} + +// Removes network permissions. +func (s *NetworkService) RemoveNetworkPermissions(p *RemoveNetworkPermissionsParams) (*RemoveNetworkPermissionsResponse, error) { + resp, err := s.cs.newRequest("removeNetworkPermissions", p.toURLValues()) + if err != nil { + return nil, err + } + + var r RemoveNetworkPermissionsResponse + if err := json.Unmarshal(resp, &r); err != nil { + return nil, err + } + + return &r, nil +} + +type RemoveNetworkPermissionsResponse struct { + Displaytext string `json:"displaytext"` + JobID string `json:"jobid"` + Jobstatus int `json:"jobstatus"` + Success bool `json:"success"` +} + +func (r *RemoveNetworkPermissionsResponse) UnmarshalJSON(b []byte) error { + var m map[string]interface{} + err := json.Unmarshal(b, &m) + if err != nil { + return err + } + + if success, ok := m["success"].(string); ok { + m["success"] = success == "true" + b, err = json.Marshal(m) + if err != nil { + return err + } + } + + if ostypeid, ok := m["ostypeid"].(float64); ok { + m["ostypeid"] = strconv.Itoa(int(ostypeid)) + b, err = json.Marshal(m) + if err != nil { + return err + } + } + + type alias RemoveNetworkPermissionsResponse + return json.Unmarshal(b, (*alias)(r)) +} diff --git a/cloudstack/NetworkService_mock.go b/cloudstack/NetworkService_mock.go index 1e5efd3..82f872e 100644 --- a/cloudstack/NetworkService_mock.go +++ b/cloudstack/NetworkService_mock.go @@ -82,6 +82,21 @@ func (mr *MockNetworkServiceIfaceMockRecorder) AddOpenDaylightController(p inter return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "AddOpenDaylightController", reflect.TypeOf((*MockNetworkServiceIface)(nil).AddOpenDaylightController), p) } +// CreateGuestNetworkIpv6Prefix mocks base method. +func (m *MockNetworkServiceIface) CreateGuestNetworkIpv6Prefix(p *CreateGuestNetworkIpv6PrefixParams) (*CreateGuestNetworkIpv6PrefixResponse, error) { + m.ctrl.T.Helper() + ret := m.ctrl.Call(m, "CreateGuestNetworkIpv6Prefix", p) + ret0, _ := ret[0].(*CreateGuestNetworkIpv6PrefixResponse) + ret1, _ := ret[1].(error) + return ret0, ret1 +} + +// CreateGuestNetworkIpv6Prefix indicates an expected call of CreateGuestNetworkIpv6Prefix. +func (mr *MockNetworkServiceIfaceMockRecorder) CreateGuestNetworkIpv6Prefix(p interface{}) *gomock.Call { + mr.mock.ctrl.T.Helper() + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "CreateGuestNetworkIpv6Prefix", reflect.TypeOf((*MockNetworkServiceIface)(nil).CreateGuestNetworkIpv6Prefix), p) +} + // CreateNetwork mocks base method. func (m *MockNetworkServiceIface) CreateNetwork(p *CreateNetworkParams) (*CreateNetworkResponse, error) { m.ctrl.T.Helper() @@ -97,6 +112,21 @@ func (mr *MockNetworkServiceIfaceMockRecorder) CreateNetwork(p interface{}) *gom return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "CreateNetwork", reflect.TypeOf((*MockNetworkServiceIface)(nil).CreateNetwork), p) } +// CreateNetworkPermissions mocks base method. +func (m *MockNetworkServiceIface) CreateNetworkPermissions(p *CreateNetworkPermissionsParams) (*CreateNetworkPermissionsResponse, error) { + m.ctrl.T.Helper() + ret := m.ctrl.Call(m, "CreateNetworkPermissions", p) + ret0, _ := ret[0].(*CreateNetworkPermissionsResponse) + ret1, _ := ret[1].(error) + return ret0, ret1 +} + +// CreateNetworkPermissions indicates an expected call of CreateNetworkPermissions. +func (mr *MockNetworkServiceIfaceMockRecorder) CreateNetworkPermissions(p interface{}) *gomock.Call { + mr.mock.ctrl.T.Helper() + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "CreateNetworkPermissions", reflect.TypeOf((*MockNetworkServiceIface)(nil).CreateNetworkPermissions), p) +} + // CreatePhysicalNetwork mocks base method. func (m *MockNetworkServiceIface) CreatePhysicalNetwork(p *CreatePhysicalNetworkParams) (*CreatePhysicalNetworkResponse, error) { m.ctrl.T.Helper() @@ -157,6 +187,21 @@ func (mr *MockNetworkServiceIfaceMockRecorder) DedicatePublicIpRange(p interface return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "DedicatePublicIpRange", reflect.TypeOf((*MockNetworkServiceIface)(nil).DedicatePublicIpRange), p) } +// DeleteGuestNetworkIpv6Prefix mocks base method. +func (m *MockNetworkServiceIface) DeleteGuestNetworkIpv6Prefix(p *DeleteGuestNetworkIpv6PrefixParams) (*DeleteGuestNetworkIpv6PrefixResponse, error) { + m.ctrl.T.Helper() + ret := m.ctrl.Call(m, "DeleteGuestNetworkIpv6Prefix", p) + ret0, _ := ret[0].(*DeleteGuestNetworkIpv6PrefixResponse) + ret1, _ := ret[1].(error) + return ret0, ret1 +} + +// DeleteGuestNetworkIpv6Prefix indicates an expected call of DeleteGuestNetworkIpv6Prefix. +func (mr *MockNetworkServiceIfaceMockRecorder) DeleteGuestNetworkIpv6Prefix(p interface{}) *gomock.Call { + mr.mock.ctrl.T.Helper() + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "DeleteGuestNetworkIpv6Prefix", reflect.TypeOf((*MockNetworkServiceIface)(nil).DeleteGuestNetworkIpv6Prefix), p) +} + // DeleteNetwork mocks base method. func (m *MockNetworkServiceIface) DeleteNetwork(p *DeleteNetworkParams) (*DeleteNetworkResponse, error) { m.ctrl.T.Helper() @@ -232,6 +277,27 @@ func (mr *MockNetworkServiceIfaceMockRecorder) DeleteStorageNetworkIpRange(p int return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "DeleteStorageNetworkIpRange", reflect.TypeOf((*MockNetworkServiceIface)(nil).DeleteStorageNetworkIpRange), p) } +// GetGuestNetworkIpv6PrefixeByID mocks base method. +func (m *MockNetworkServiceIface) GetGuestNetworkIpv6PrefixeByID(id string, opts ...OptionFunc) (*GuestNetworkIpv6Prefixe, int, error) { + m.ctrl.T.Helper() + varargs := []interface{}{id} + for _, a := range opts { + varargs = append(varargs, a) + } + ret := m.ctrl.Call(m, "GetGuestNetworkIpv6PrefixeByID", varargs...) + ret0, _ := ret[0].(*GuestNetworkIpv6Prefixe) + ret1, _ := ret[1].(int) + ret2, _ := ret[2].(error) + return ret0, ret1, ret2 +} + +// GetGuestNetworkIpv6PrefixeByID indicates an expected call of GetGuestNetworkIpv6PrefixeByID. +func (mr *MockNetworkServiceIfaceMockRecorder) GetGuestNetworkIpv6PrefixeByID(id interface{}, opts ...interface{}) *gomock.Call { + mr.mock.ctrl.T.Helper() + varargs := append([]interface{}{id}, opts...) + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "GetGuestNetworkIpv6PrefixeByID", reflect.TypeOf((*MockNetworkServiceIface)(nil).GetGuestNetworkIpv6PrefixeByID), varargs...) +} + // GetNetscalerLoadBalancerNetworkID mocks base method. func (m *MockNetworkServiceIface) GetNetscalerLoadBalancerNetworkID(keyword, lbdeviceid string, opts ...OptionFunc) (string, int, error) { m.ctrl.T.Helper() @@ -484,6 +550,21 @@ func (mr *MockNetworkServiceIfaceMockRecorder) GetStorageNetworkIpRangeByID(id i return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "GetStorageNetworkIpRangeByID", reflect.TypeOf((*MockNetworkServiceIface)(nil).GetStorageNetworkIpRangeByID), varargs...) } +// ListGuestNetworkIpv6Prefixes mocks base method. +func (m *MockNetworkServiceIface) ListGuestNetworkIpv6Prefixes(p *ListGuestNetworkIpv6PrefixesParams) (*ListGuestNetworkIpv6PrefixesResponse, error) { + m.ctrl.T.Helper() + ret := m.ctrl.Call(m, "ListGuestNetworkIpv6Prefixes", p) + ret0, _ := ret[0].(*ListGuestNetworkIpv6PrefixesResponse) + ret1, _ := ret[1].(error) + return ret0, ret1 +} + +// ListGuestNetworkIpv6Prefixes indicates an expected call of ListGuestNetworkIpv6Prefixes. +func (mr *MockNetworkServiceIfaceMockRecorder) ListGuestNetworkIpv6Prefixes(p interface{}) *gomock.Call { + mr.mock.ctrl.T.Helper() + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "ListGuestNetworkIpv6Prefixes", reflect.TypeOf((*MockNetworkServiceIface)(nil).ListGuestNetworkIpv6Prefixes), p) +} + // ListNetscalerLoadBalancerNetworks mocks base method. func (m *MockNetworkServiceIface) ListNetscalerLoadBalancerNetworks(p *ListNetscalerLoadBalancerNetworksParams) (*ListNetscalerLoadBalancerNetworksResponse, error) { m.ctrl.T.Helper() @@ -514,6 +595,21 @@ func (mr *MockNetworkServiceIfaceMockRecorder) ListNetworkIsolationMethods(p int return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "ListNetworkIsolationMethods", reflect.TypeOf((*MockNetworkServiceIface)(nil).ListNetworkIsolationMethods), p) } +// ListNetworkPermissions mocks base method. +func (m *MockNetworkServiceIface) ListNetworkPermissions(p *ListNetworkPermissionsParams) (*ListNetworkPermissionsResponse, error) { + m.ctrl.T.Helper() + ret := m.ctrl.Call(m, "ListNetworkPermissions", p) + ret0, _ := ret[0].(*ListNetworkPermissionsResponse) + ret1, _ := ret[1].(error) + return ret0, ret1 +} + +// ListNetworkPermissions indicates an expected call of ListNetworkPermissions. +func (mr *MockNetworkServiceIfaceMockRecorder) ListNetworkPermissions(p interface{}) *gomock.Call { + mr.mock.ctrl.T.Helper() + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "ListNetworkPermissions", reflect.TypeOf((*MockNetworkServiceIface)(nil).ListNetworkPermissions), p) +} + // ListNetworkServiceProviders mocks base method. func (m *MockNetworkServiceIface) ListNetworkServiceProviders(p *ListNetworkServiceProvidersParams) (*ListNetworkServiceProvidersResponse, error) { m.ctrl.T.Helper() @@ -662,6 +758,20 @@ func (mr *MockNetworkServiceIfaceMockRecorder) NewAddOpenDaylightControllerParam return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "NewAddOpenDaylightControllerParams", reflect.TypeOf((*MockNetworkServiceIface)(nil).NewAddOpenDaylightControllerParams), password, physicalnetworkid, url, username) } +// NewCreateGuestNetworkIpv6PrefixParams mocks base method. +func (m *MockNetworkServiceIface) NewCreateGuestNetworkIpv6PrefixParams(prefix, zoneid string) *CreateGuestNetworkIpv6PrefixParams { + m.ctrl.T.Helper() + ret := m.ctrl.Call(m, "NewCreateGuestNetworkIpv6PrefixParams", prefix, zoneid) + ret0, _ := ret[0].(*CreateGuestNetworkIpv6PrefixParams) + return ret0 +} + +// NewCreateGuestNetworkIpv6PrefixParams indicates an expected call of NewCreateGuestNetworkIpv6PrefixParams. +func (mr *MockNetworkServiceIfaceMockRecorder) NewCreateGuestNetworkIpv6PrefixParams(prefix, zoneid interface{}) *gomock.Call { + mr.mock.ctrl.T.Helper() + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "NewCreateGuestNetworkIpv6PrefixParams", reflect.TypeOf((*MockNetworkServiceIface)(nil).NewCreateGuestNetworkIpv6PrefixParams), prefix, zoneid) +} + // NewCreateNetworkParams mocks base method. func (m *MockNetworkServiceIface) NewCreateNetworkParams(displaytext, name, networkofferingid, zoneid string) *CreateNetworkParams { m.ctrl.T.Helper() @@ -676,6 +786,20 @@ func (mr *MockNetworkServiceIfaceMockRecorder) NewCreateNetworkParams(displaytex return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "NewCreateNetworkParams", reflect.TypeOf((*MockNetworkServiceIface)(nil).NewCreateNetworkParams), displaytext, name, networkofferingid, zoneid) } +// NewCreateNetworkPermissionsParams mocks base method. +func (m *MockNetworkServiceIface) NewCreateNetworkPermissionsParams(networkid string) *CreateNetworkPermissionsParams { + m.ctrl.T.Helper() + ret := m.ctrl.Call(m, "NewCreateNetworkPermissionsParams", networkid) + ret0, _ := ret[0].(*CreateNetworkPermissionsParams) + return ret0 +} + +// NewCreateNetworkPermissionsParams indicates an expected call of NewCreateNetworkPermissionsParams. +func (mr *MockNetworkServiceIfaceMockRecorder) NewCreateNetworkPermissionsParams(networkid interface{}) *gomock.Call { + mr.mock.ctrl.T.Helper() + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "NewCreateNetworkPermissionsParams", reflect.TypeOf((*MockNetworkServiceIface)(nil).NewCreateNetworkPermissionsParams), networkid) +} + // NewCreatePhysicalNetworkParams mocks base method. func (m *MockNetworkServiceIface) NewCreatePhysicalNetworkParams(name, zoneid string) *CreatePhysicalNetworkParams { m.ctrl.T.Helper() @@ -732,6 +856,20 @@ func (mr *MockNetworkServiceIfaceMockRecorder) NewDedicatePublicIpRangeParams(do return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "NewDedicatePublicIpRangeParams", reflect.TypeOf((*MockNetworkServiceIface)(nil).NewDedicatePublicIpRangeParams), domainid, id) } +// NewDeleteGuestNetworkIpv6PrefixParams mocks base method. +func (m *MockNetworkServiceIface) NewDeleteGuestNetworkIpv6PrefixParams(id string) *DeleteGuestNetworkIpv6PrefixParams { + m.ctrl.T.Helper() + ret := m.ctrl.Call(m, "NewDeleteGuestNetworkIpv6PrefixParams", id) + ret0, _ := ret[0].(*DeleteGuestNetworkIpv6PrefixParams) + return ret0 +} + +// NewDeleteGuestNetworkIpv6PrefixParams indicates an expected call of NewDeleteGuestNetworkIpv6PrefixParams. +func (mr *MockNetworkServiceIfaceMockRecorder) NewDeleteGuestNetworkIpv6PrefixParams(id interface{}) *gomock.Call { + mr.mock.ctrl.T.Helper() + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "NewDeleteGuestNetworkIpv6PrefixParams", reflect.TypeOf((*MockNetworkServiceIface)(nil).NewDeleteGuestNetworkIpv6PrefixParams), id) +} + // NewDeleteNetworkParams mocks base method. func (m *MockNetworkServiceIface) NewDeleteNetworkParams(id string) *DeleteNetworkParams { m.ctrl.T.Helper() @@ -802,6 +940,20 @@ func (mr *MockNetworkServiceIfaceMockRecorder) NewDeleteStorageNetworkIpRangePar return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "NewDeleteStorageNetworkIpRangeParams", reflect.TypeOf((*MockNetworkServiceIface)(nil).NewDeleteStorageNetworkIpRangeParams), id) } +// NewListGuestNetworkIpv6PrefixesParams mocks base method. +func (m *MockNetworkServiceIface) NewListGuestNetworkIpv6PrefixesParams() *ListGuestNetworkIpv6PrefixesParams { + m.ctrl.T.Helper() + ret := m.ctrl.Call(m, "NewListGuestNetworkIpv6PrefixesParams") + ret0, _ := ret[0].(*ListGuestNetworkIpv6PrefixesParams) + return ret0 +} + +// NewListGuestNetworkIpv6PrefixesParams indicates an expected call of NewListGuestNetworkIpv6PrefixesParams. +func (mr *MockNetworkServiceIfaceMockRecorder) NewListGuestNetworkIpv6PrefixesParams() *gomock.Call { + mr.mock.ctrl.T.Helper() + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "NewListGuestNetworkIpv6PrefixesParams", reflect.TypeOf((*MockNetworkServiceIface)(nil).NewListGuestNetworkIpv6PrefixesParams)) +} + // NewListNetscalerLoadBalancerNetworksParams mocks base method. func (m *MockNetworkServiceIface) NewListNetscalerLoadBalancerNetworksParams(lbdeviceid string) *ListNetscalerLoadBalancerNetworksParams { m.ctrl.T.Helper() @@ -830,6 +982,20 @@ func (mr *MockNetworkServiceIfaceMockRecorder) NewListNetworkIsolationMethodsPar return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "NewListNetworkIsolationMethodsParams", reflect.TypeOf((*MockNetworkServiceIface)(nil).NewListNetworkIsolationMethodsParams)) } +// NewListNetworkPermissionsParams mocks base method. +func (m *MockNetworkServiceIface) NewListNetworkPermissionsParams(networkid string) *ListNetworkPermissionsParams { + m.ctrl.T.Helper() + ret := m.ctrl.Call(m, "NewListNetworkPermissionsParams", networkid) + ret0, _ := ret[0].(*ListNetworkPermissionsParams) + return ret0 +} + +// NewListNetworkPermissionsParams indicates an expected call of NewListNetworkPermissionsParams. +func (mr *MockNetworkServiceIfaceMockRecorder) NewListNetworkPermissionsParams(networkid interface{}) *gomock.Call { + mr.mock.ctrl.T.Helper() + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "NewListNetworkPermissionsParams", reflect.TypeOf((*MockNetworkServiceIface)(nil).NewListNetworkPermissionsParams), networkid) +} + // NewListNetworkServiceProvidersParams mocks base method. func (m *MockNetworkServiceIface) NewListNetworkServiceProvidersParams() *ListNetworkServiceProvidersParams { m.ctrl.T.Helper() @@ -956,6 +1122,34 @@ func (mr *MockNetworkServiceIfaceMockRecorder) NewReleasePublicIpRangeParams(id return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "NewReleasePublicIpRangeParams", reflect.TypeOf((*MockNetworkServiceIface)(nil).NewReleasePublicIpRangeParams), id) } +// NewRemoveNetworkPermissionsParams mocks base method. +func (m *MockNetworkServiceIface) NewRemoveNetworkPermissionsParams(networkid string) *RemoveNetworkPermissionsParams { + m.ctrl.T.Helper() + ret := m.ctrl.Call(m, "NewRemoveNetworkPermissionsParams", networkid) + ret0, _ := ret[0].(*RemoveNetworkPermissionsParams) + return ret0 +} + +// NewRemoveNetworkPermissionsParams indicates an expected call of NewRemoveNetworkPermissionsParams. +func (mr *MockNetworkServiceIfaceMockRecorder) NewRemoveNetworkPermissionsParams(networkid interface{}) *gomock.Call { + mr.mock.ctrl.T.Helper() + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "NewRemoveNetworkPermissionsParams", reflect.TypeOf((*MockNetworkServiceIface)(nil).NewRemoveNetworkPermissionsParams), networkid) +} + +// NewResetNetworkPermissionsParams mocks base method. +func (m *MockNetworkServiceIface) NewResetNetworkPermissionsParams(networkid string) *ResetNetworkPermissionsParams { + m.ctrl.T.Helper() + ret := m.ctrl.Call(m, "NewResetNetworkPermissionsParams", networkid) + ret0, _ := ret[0].(*ResetNetworkPermissionsParams) + return ret0 +} + +// NewResetNetworkPermissionsParams indicates an expected call of NewResetNetworkPermissionsParams. +func (mr *MockNetworkServiceIfaceMockRecorder) NewResetNetworkPermissionsParams(networkid interface{}) *gomock.Call { + mr.mock.ctrl.T.Helper() + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "NewResetNetworkPermissionsParams", reflect.TypeOf((*MockNetworkServiceIface)(nil).NewResetNetworkPermissionsParams), networkid) +} + // NewRestartNetworkParams mocks base method. func (m *MockNetworkServiceIface) NewRestartNetworkParams(id string) *RestartNetworkParams { m.ctrl.T.Helper() @@ -1041,6 +1235,36 @@ func (mr *MockNetworkServiceIfaceMockRecorder) ReleasePublicIpRange(p interface{ return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "ReleasePublicIpRange", reflect.TypeOf((*MockNetworkServiceIface)(nil).ReleasePublicIpRange), p) } +// RemoveNetworkPermissions mocks base method. +func (m *MockNetworkServiceIface) RemoveNetworkPermissions(p *RemoveNetworkPermissionsParams) (*RemoveNetworkPermissionsResponse, error) { + m.ctrl.T.Helper() + ret := m.ctrl.Call(m, "RemoveNetworkPermissions", p) + ret0, _ := ret[0].(*RemoveNetworkPermissionsResponse) + ret1, _ := ret[1].(error) + return ret0, ret1 +} + +// RemoveNetworkPermissions indicates an expected call of RemoveNetworkPermissions. +func (mr *MockNetworkServiceIfaceMockRecorder) RemoveNetworkPermissions(p interface{}) *gomock.Call { + mr.mock.ctrl.T.Helper() + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "RemoveNetworkPermissions", reflect.TypeOf((*MockNetworkServiceIface)(nil).RemoveNetworkPermissions), p) +} + +// ResetNetworkPermissions mocks base method. +func (m *MockNetworkServiceIface) ResetNetworkPermissions(p *ResetNetworkPermissionsParams) (*ResetNetworkPermissionsResponse, error) { + m.ctrl.T.Helper() + ret := m.ctrl.Call(m, "ResetNetworkPermissions", p) + ret0, _ := ret[0].(*ResetNetworkPermissionsResponse) + ret1, _ := ret[1].(error) + return ret0, ret1 +} + +// ResetNetworkPermissions indicates an expected call of ResetNetworkPermissions. +func (mr *MockNetworkServiceIfaceMockRecorder) ResetNetworkPermissions(p interface{}) *gomock.Call { + mr.mock.ctrl.T.Helper() + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "ResetNetworkPermissions", reflect.TypeOf((*MockNetworkServiceIface)(nil).ResetNetworkPermissions), p) +} + // RestartNetwork mocks base method. func (m *MockNetworkServiceIface) RestartNetwork(p *RestartNetworkParams) (*RestartNetworkResponse, error) { m.ctrl.T.Helper() diff --git a/cloudstack/NicService.go b/cloudstack/NicService.go index 471edae..13ae6c8 100644 --- a/cloudstack/NicService.go +++ b/cloudstack/NicService.go @@ -344,6 +344,8 @@ type Nic struct { Type string `json:"type"` Virtualmachineid string `json:"virtualmachineid"` Vlanid int `json:"vlanid"` + Vpcid string `json:"vpcid"` + Vpcname string `json:"vpcname"` } type RemoveIpFromNicParams struct { @@ -554,7 +556,7 @@ type UpdateVmNicIpResponse struct { Isoname string `json:"isoname"` JobID string `json:"jobid"` Jobstatus int `json:"jobstatus"` - Keypair string `json:"keypair"` + Keypairs string `json:"keypairs"` Lastupdated string `json:"lastupdated"` Memory int `json:"memory"` Memoryintfreekbs int64 `json:"memoryintfreekbs"` diff --git a/cloudstack/PodService.go b/cloudstack/PodService.go index 7766d8d..723de17 100644 --- a/cloudstack/PodService.go +++ b/cloudstack/PodService.go @@ -233,8 +233,10 @@ type CreatePodResponse struct { } type CreatePodResponseIpranges struct { + Cidr string `json:"cidr"` Endip string `json:"endip"` Forsystemvms string `json:"forsystemvms"` + Gateway string `json:"gateway"` Startip string `json:"startip"` Vlanid string `json:"vlanid"` } @@ -933,8 +935,10 @@ type Pod struct { } type PodIpranges struct { + Cidr string `json:"cidr"` Endip string `json:"endip"` Forsystemvms string `json:"forsystemvms"` + Gateway string `json:"gateway"` Startip string `json:"startip"` Vlanid string `json:"vlanid"` } @@ -1212,8 +1216,10 @@ type UpdatePodResponse struct { } type UpdatePodResponseIpranges struct { + Cidr string `json:"cidr"` Endip string `json:"endip"` Forsystemvms string `json:"forsystemvms"` + Gateway string `json:"gateway"` Startip string `json:"startip"` Vlanid string `json:"vlanid"` } diff --git a/cloudstack/RouterService.go b/cloudstack/RouterService.go index 8c4f81a..0a7bad7 100644 --- a/cloudstack/RouterService.go +++ b/cloudstack/RouterService.go @@ -171,6 +171,7 @@ type ChangeServiceForRouterResponse struct { Scriptsversion string `json:"scriptsversion"` Serviceofferingid string `json:"serviceofferingid"` Serviceofferingname string `json:"serviceofferingname"` + Softwareversion string `json:"softwareversion"` State string `json:"state"` Templateid string `json:"templateid"` Templatename string `json:"templatename"` @@ -521,6 +522,7 @@ type DestroyRouterResponse struct { Scriptsversion string `json:"scriptsversion"` Serviceofferingid string `json:"serviceofferingid"` Serviceofferingname string `json:"serviceofferingname"` + Softwareversion string `json:"softwareversion"` State string `json:"state"` Templateid string `json:"templateid"` Templatename string `json:"templatename"` @@ -1093,6 +1095,7 @@ type Router struct { Scriptsversion string `json:"scriptsversion"` Serviceofferingid string `json:"serviceofferingid"` Serviceofferingname string `json:"serviceofferingname"` + Softwareversion string `json:"softwareversion"` State string `json:"state"` Templateid string `json:"templateid"` Templatename string `json:"templatename"` @@ -1447,6 +1450,7 @@ type RebootRouterResponse struct { Scriptsversion string `json:"scriptsversion"` Serviceofferingid string `json:"serviceofferingid"` Serviceofferingname string `json:"serviceofferingname"` + Softwareversion string `json:"softwareversion"` State string `json:"state"` Templateid string `json:"templateid"` Templatename string `json:"templatename"` @@ -1585,6 +1589,7 @@ type StartRouterResponse struct { Scriptsversion string `json:"scriptsversion"` Serviceofferingid string `json:"serviceofferingid"` Serviceofferingname string `json:"serviceofferingname"` + Softwareversion string `json:"softwareversion"` State string `json:"state"` Templateid string `json:"templateid"` Templatename string `json:"templatename"` @@ -1742,6 +1747,7 @@ type StopRouterResponse struct { Scriptsversion string `json:"scriptsversion"` Serviceofferingid string `json:"serviceofferingid"` Serviceofferingname string `json:"serviceofferingname"` + Softwareversion string `json:"softwareversion"` State string `json:"state"` Templateid string `json:"templateid"` Templatename string `json:"templatename"` diff --git a/cloudstack/SSHService.go b/cloudstack/SSHService.go index da7f6e9..45274cd 100644 --- a/cloudstack/SSHService.go +++ b/cloudstack/SSHService.go @@ -40,7 +40,7 @@ type SSHServiceIface interface { RegisterSSHKeyPair(p *RegisterSSHKeyPairParams) (*RegisterSSHKeyPairResponse, error) NewRegisterSSHKeyPairParams(name string, publickey string) *RegisterSSHKeyPairParams ResetSSHKeyForVirtualMachine(p *ResetSSHKeyForVirtualMachineParams) (*ResetSSHKeyForVirtualMachineResponse, error) - NewResetSSHKeyForVirtualMachineParams(id string, keypair string) *ResetSSHKeyForVirtualMachineParams + NewResetSSHKeyForVirtualMachineParams(id string) *ResetSSHKeyForVirtualMachineParams } type CreateSSHKeyPairParams struct { @@ -811,6 +811,10 @@ func (p *ResetSSHKeyForVirtualMachineParams) toURLValues() url.Values { if v, found := p.p["keypair"]; found { u.Set("keypair", v.(string)) } + if v, found := p.p["keypairs"]; found { + vv := strings.Join(v.([]string), ",") + u.Set("keypairs", vv) + } if v, found := p.p["projectid"]; found { u.Set("projectid", v.(string)) } @@ -877,6 +881,21 @@ func (p *ResetSSHKeyForVirtualMachineParams) GetKeypair() (string, bool) { return value, ok } +func (p *ResetSSHKeyForVirtualMachineParams) SetKeypairs(v []string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["keypairs"] = v +} + +func (p *ResetSSHKeyForVirtualMachineParams) GetKeypairs() ([]string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["keypairs"].([]string) + return value, ok +} + func (p *ResetSSHKeyForVirtualMachineParams) SetProjectid(v string) { if p.p == nil { p.p = make(map[string]interface{}) @@ -894,11 +913,10 @@ func (p *ResetSSHKeyForVirtualMachineParams) GetProjectid() (string, bool) { // You should always use this function to get a new ResetSSHKeyForVirtualMachineParams instance, // as then you are sure you have configured all required params -func (s *SSHService) NewResetSSHKeyForVirtualMachineParams(id string, keypair string) *ResetSSHKeyForVirtualMachineParams { +func (s *SSHService) NewResetSSHKeyForVirtualMachineParams(id string) *ResetSSHKeyForVirtualMachineParams { p := &ResetSSHKeyForVirtualMachineParams{} p.p = make(map[string]interface{}) p.p["id"] = id - p.p["keypair"] = keypair return p } @@ -977,7 +995,7 @@ type ResetSSHKeyForVirtualMachineResponse struct { Isoname string `json:"isoname"` JobID string `json:"jobid"` Jobstatus int `json:"jobstatus"` - Keypair string `json:"keypair"` + Keypairs string `json:"keypairs"` Lastupdated string `json:"lastupdated"` Memory int `json:"memory"` Memoryintfreekbs int64 `json:"memoryintfreekbs"` diff --git a/cloudstack/SSHService_mock.go b/cloudstack/SSHService_mock.go index 0ea3ed6..fa39fa5 100644 --- a/cloudstack/SSHService_mock.go +++ b/cloudstack/SSHService_mock.go @@ -217,17 +217,17 @@ func (mr *MockSSHServiceIfaceMockRecorder) NewRegisterSSHKeyPairParams(name, pub } // NewResetSSHKeyForVirtualMachineParams mocks base method. -func (m *MockSSHServiceIface) NewResetSSHKeyForVirtualMachineParams(id, keypair string) *ResetSSHKeyForVirtualMachineParams { +func (m *MockSSHServiceIface) NewResetSSHKeyForVirtualMachineParams(id string) *ResetSSHKeyForVirtualMachineParams { m.ctrl.T.Helper() - ret := m.ctrl.Call(m, "NewResetSSHKeyForVirtualMachineParams", id, keypair) + ret := m.ctrl.Call(m, "NewResetSSHKeyForVirtualMachineParams", id) ret0, _ := ret[0].(*ResetSSHKeyForVirtualMachineParams) return ret0 } // NewResetSSHKeyForVirtualMachineParams indicates an expected call of NewResetSSHKeyForVirtualMachineParams. -func (mr *MockSSHServiceIfaceMockRecorder) NewResetSSHKeyForVirtualMachineParams(id, keypair interface{}) *gomock.Call { +func (mr *MockSSHServiceIfaceMockRecorder) NewResetSSHKeyForVirtualMachineParams(id interface{}) *gomock.Call { mr.mock.ctrl.T.Helper() - return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "NewResetSSHKeyForVirtualMachineParams", reflect.TypeOf((*MockSSHServiceIface)(nil).NewResetSSHKeyForVirtualMachineParams), id, keypair) + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "NewResetSSHKeyForVirtualMachineParams", reflect.TypeOf((*MockSSHServiceIface)(nil).NewResetSSHKeyForVirtualMachineParams), id) } // RegisterSSHKeyPair mocks base method. diff --git a/cloudstack/ServiceOfferingService.go b/cloudstack/ServiceOfferingService.go index 402ef15..5dc3aa6 100644 --- a/cloudstack/ServiceOfferingService.go +++ b/cloudstack/ServiceOfferingService.go @@ -96,6 +96,13 @@ func (p *CreateServiceOfferingParams) toURLValues() url.Values { if v, found := p.p["deploymentplanner"]; found { u.Set("deploymentplanner", v.(string)) } + if v, found := p.p["diskofferingid"]; found { + u.Set("diskofferingid", v.(string)) + } + if v, found := p.p["diskofferingstrictness"]; found { + vv := strconv.FormatBool(v.(bool)) + u.Set("diskofferingstrictness", vv) + } if v, found := p.p["displaytext"]; found { u.Set("displaytext", v.(string)) } @@ -402,6 +409,36 @@ func (p *CreateServiceOfferingParams) GetDeploymentplanner() (string, bool) { return value, ok } +func (p *CreateServiceOfferingParams) SetDiskofferingid(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["diskofferingid"] = v +} + +func (p *CreateServiceOfferingParams) GetDiskofferingid() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["diskofferingid"].(string) + return value, ok +} + +func (p *CreateServiceOfferingParams) SetDiskofferingstrictness(v bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["diskofferingstrictness"] = v +} + +func (p *CreateServiceOfferingParams) GetDiskofferingstrictness() (bool, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["diskofferingstrictness"].(bool) + return value, ok +} + func (p *CreateServiceOfferingParams) SetDisplaytext(v string) { if p.p == nil { p.p = make(map[string]interface{}) @@ -930,6 +967,10 @@ type CreateServiceOfferingResponse struct { DiskIopsWriteRate int64 `json:"diskIopsWriteRate"` DiskIopsWriteRateMax int64 `json:"diskIopsWriteRateMax"` DiskIopsWriteRateMaxLength int64 `json:"diskIopsWriteRateMaxLength"` + Diskofferingdisplaytext string `json:"diskofferingdisplaytext"` + Diskofferingid string `json:"diskofferingid"` + Diskofferingname string `json:"diskofferingname"` + Diskofferingstrictness bool `json:"diskofferingstrictness"` Displaytext string `json:"displaytext"` Domain string `json:"domain"` Domainid string `json:"domainid"` @@ -1470,6 +1511,10 @@ type ServiceOffering struct { DiskIopsWriteRate int64 `json:"diskIopsWriteRate"` DiskIopsWriteRateMax int64 `json:"diskIopsWriteRateMax"` DiskIopsWriteRateMaxLength int64 `json:"diskIopsWriteRateMaxLength"` + Diskofferingdisplaytext string `json:"diskofferingdisplaytext"` + Diskofferingid string `json:"diskofferingid"` + Diskofferingname string `json:"diskofferingname"` + Diskofferingstrictness bool `json:"diskofferingstrictness"` Displaytext string `json:"displaytext"` Domain string `json:"domain"` Domainid string `json:"domainid"` @@ -1706,6 +1751,10 @@ type UpdateServiceOfferingResponse struct { DiskIopsWriteRate int64 `json:"diskIopsWriteRate"` DiskIopsWriteRateMax int64 `json:"diskIopsWriteRateMax"` DiskIopsWriteRateMaxLength int64 `json:"diskIopsWriteRateMaxLength"` + Diskofferingdisplaytext string `json:"diskofferingdisplaytext"` + Diskofferingid string `json:"diskofferingid"` + Diskofferingname string `json:"diskofferingname"` + Diskofferingstrictness bool `json:"diskofferingstrictness"` Displaytext string `json:"displaytext"` Domain string `json:"domain"` Domainid string `json:"domainid"` diff --git a/cloudstack/SnapshotService.go b/cloudstack/SnapshotService.go index c0b5a86..d84aa57 100644 --- a/cloudstack/SnapshotService.go +++ b/cloudstack/SnapshotService.go @@ -2237,7 +2237,7 @@ type RevertToVMSnapshotResponse struct { Isoname string `json:"isoname"` JobID string `json:"jobid"` Jobstatus int `json:"jobstatus"` - Keypair string `json:"keypair"` + Keypairs string `json:"keypairs"` Lastupdated string `json:"lastupdated"` Memory int `json:"memory"` Memoryintfreekbs int64 `json:"memoryintfreekbs"` diff --git a/cloudstack/SystemVMService.go b/cloudstack/SystemVMService.go index 9f648b2..36e418e 100644 --- a/cloudstack/SystemVMService.go +++ b/cloudstack/SystemVMService.go @@ -47,6 +47,8 @@ type SystemVMServiceIface interface { NewStartSystemVmParams(id string) *StartSystemVmParams StopSystemVm(p *StopSystemVmParams) (*StopSystemVmResponse, error) NewStopSystemVmParams(id string) *StopSystemVmParams + PatchSystemVm(p *PatchSystemVmParams) (*PatchSystemVmResponse, error) + NewPatchSystemVmParams() *PatchSystemVmParams } type ChangeServiceForSystemVmParams struct { @@ -1362,3 +1364,97 @@ type StopSystemVmResponse struct { Zoneid string `json:"zoneid"` Zonename string `json:"zonename"` } + +type PatchSystemVmParams struct { + p map[string]interface{} +} + +func (p *PatchSystemVmParams) toURLValues() url.Values { + u := url.Values{} + if p.p == nil { + return u + } + if v, found := p.p["forced"]; found { + vv := strconv.FormatBool(v.(bool)) + u.Set("forced", vv) + } + if v, found := p.p["id"]; found { + u.Set("id", v.(string)) + } + return u +} + +func (p *PatchSystemVmParams) SetForced(v bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["forced"] = v +} + +func (p *PatchSystemVmParams) GetForced() (bool, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["forced"].(bool) + return value, ok +} + +func (p *PatchSystemVmParams) SetId(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["id"] = v +} + +func (p *PatchSystemVmParams) GetId() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["id"].(string) + return value, ok +} + +// You should always use this function to get a new PatchSystemVmParams instance, +// as then you are sure you have configured all required params +func (s *SystemVMService) NewPatchSystemVmParams() *PatchSystemVmParams { + p := &PatchSystemVmParams{} + p.p = make(map[string]interface{}) + return p +} + +// Attempts to live patch systemVMs - CPVM, SSVM +func (s *SystemVMService) PatchSystemVm(p *PatchSystemVmParams) (*PatchSystemVmResponse, error) { + resp, err := s.cs.newRequest("patchSystemVm", p.toURLValues()) + if err != nil { + return nil, err + } + + var r PatchSystemVmResponse + if err := json.Unmarshal(resp, &r); err != nil { + return nil, err + } + + // If we have a async client, we need to wait for the async result + if s.cs.async { + b, err := s.cs.GetAsyncJobResult(r.JobID, s.cs.timeout) + if err != nil { + if err == AsyncTimeoutErr { + return &r, err + } + return nil, err + } + + if err := json.Unmarshal(b, &r); err != nil { + return nil, err + } + } + + return &r, nil +} + +type PatchSystemVmResponse struct { + Displaytext string `json:"displaytext"` + JobID string `json:"jobid"` + Jobstatus int `json:"jobstatus"` + Success bool `json:"success"` +} diff --git a/cloudstack/SystemVMService_mock.go b/cloudstack/SystemVMService_mock.go index 9c03657..d29fbcb 100644 --- a/cloudstack/SystemVMService_mock.go +++ b/cloudstack/SystemVMService_mock.go @@ -231,6 +231,20 @@ func (mr *MockSystemVMServiceIfaceMockRecorder) NewMigrateSystemVmParams(virtual return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "NewMigrateSystemVmParams", reflect.TypeOf((*MockSystemVMServiceIface)(nil).NewMigrateSystemVmParams), virtualmachineid) } +// NewPatchSystemVmParams mocks base method. +func (m *MockSystemVMServiceIface) NewPatchSystemVmParams() *PatchSystemVmParams { + m.ctrl.T.Helper() + ret := m.ctrl.Call(m, "NewPatchSystemVmParams") + ret0, _ := ret[0].(*PatchSystemVmParams) + return ret0 +} + +// NewPatchSystemVmParams indicates an expected call of NewPatchSystemVmParams. +func (mr *MockSystemVMServiceIfaceMockRecorder) NewPatchSystemVmParams() *gomock.Call { + mr.mock.ctrl.T.Helper() + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "NewPatchSystemVmParams", reflect.TypeOf((*MockSystemVMServiceIface)(nil).NewPatchSystemVmParams)) +} + // NewRebootSystemVmParams mocks base method. func (m *MockSystemVMServiceIface) NewRebootSystemVmParams(id string) *RebootSystemVmParams { m.ctrl.T.Helper() @@ -287,6 +301,21 @@ func (mr *MockSystemVMServiceIfaceMockRecorder) NewStopSystemVmParams(id interfa return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "NewStopSystemVmParams", reflect.TypeOf((*MockSystemVMServiceIface)(nil).NewStopSystemVmParams), id) } +// PatchSystemVm mocks base method. +func (m *MockSystemVMServiceIface) PatchSystemVm(p *PatchSystemVmParams) (*PatchSystemVmResponse, error) { + m.ctrl.T.Helper() + ret := m.ctrl.Call(m, "PatchSystemVm", p) + ret0, _ := ret[0].(*PatchSystemVmResponse) + ret1, _ := ret[1].(error) + return ret0, ret1 +} + +// PatchSystemVm indicates an expected call of PatchSystemVm. +func (mr *MockSystemVMServiceIfaceMockRecorder) PatchSystemVm(p interface{}) *gomock.Call { + mr.mock.ctrl.T.Helper() + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "PatchSystemVm", reflect.TypeOf((*MockSystemVMServiceIface)(nil).PatchSystemVm), p) +} + // RebootSystemVm mocks base method. func (m *MockSystemVMServiceIface) RebootSystemVm(p *RebootSystemVmParams) (*RebootSystemVmResponse, error) { m.ctrl.T.Helper() diff --git a/cloudstack/TemplateService.go b/cloudstack/TemplateService.go index 3d12317..0e76a50 100644 --- a/cloudstack/TemplateService.go +++ b/cloudstack/TemplateService.go @@ -56,6 +56,11 @@ type TemplateServiceIface interface { NewUpdateTemplatePermissionsParams(id string) *UpdateTemplatePermissionsParams UpgradeRouterTemplate(p *UpgradeRouterTemplateParams) (*UpgradeRouterTemplateResponse, error) NewUpgradeRouterTemplateParams() *UpgradeRouterTemplateParams + ListTemplateDirectDownloadCertificates(p *ListTemplateDirectDownloadCertificatesParams) (*ListTemplateDirectDownloadCertificatesResponse, error) + NewListTemplateDirectDownloadCertificatesParams() *ListTemplateDirectDownloadCertificatesParams + GetTemplateDirectDownloadCertificateByID(id string, opts ...OptionFunc) (*TemplateDirectDownloadCertificate, int, error) + ProvisionTemplateDirectDownloadCertificate(p *ProvisionTemplateDirectDownloadCertificateParams) (*ProvisionTemplateDirectDownloadCertificateResponse, error) + NewProvisionTemplateDirectDownloadCertificateParams(hostid string, id string) *ProvisionTemplateDirectDownloadCertificateParams } type CopyTemplateParams struct { @@ -3632,3 +3637,285 @@ type UpgradeRouterTemplateResponse struct { JobID string `json:"jobid"` Jobstatus int `json:"jobstatus"` } + +type ListTemplateDirectDownloadCertificatesParams struct { + p map[string]interface{} +} + +func (p *ListTemplateDirectDownloadCertificatesParams) toURLValues() url.Values { + u := url.Values{} + if p.p == nil { + return u + } + if v, found := p.p["id"]; found { + u.Set("id", v.(string)) + } + if v, found := p.p["keyword"]; found { + u.Set("keyword", v.(string)) + } + if v, found := p.p["listhosts"]; found { + vv := strconv.FormatBool(v.(bool)) + u.Set("listhosts", vv) + } + if v, found := p.p["page"]; found { + vv := strconv.Itoa(v.(int)) + u.Set("page", vv) + } + if v, found := p.p["pagesize"]; found { + vv := strconv.Itoa(v.(int)) + u.Set("pagesize", vv) + } + if v, found := p.p["zoneid"]; found { + u.Set("zoneid", v.(string)) + } + return u +} + +func (p *ListTemplateDirectDownloadCertificatesParams) SetId(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["id"] = v +} + +func (p *ListTemplateDirectDownloadCertificatesParams) GetId() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["id"].(string) + return value, ok +} + +func (p *ListTemplateDirectDownloadCertificatesParams) SetKeyword(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["keyword"] = v +} + +func (p *ListTemplateDirectDownloadCertificatesParams) GetKeyword() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["keyword"].(string) + return value, ok +} + +func (p *ListTemplateDirectDownloadCertificatesParams) SetListhosts(v bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["listhosts"] = v +} + +func (p *ListTemplateDirectDownloadCertificatesParams) GetListhosts() (bool, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["listhosts"].(bool) + return value, ok +} + +func (p *ListTemplateDirectDownloadCertificatesParams) SetPage(v int) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["page"] = v +} + +func (p *ListTemplateDirectDownloadCertificatesParams) GetPage() (int, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["page"].(int) + return value, ok +} + +func (p *ListTemplateDirectDownloadCertificatesParams) SetPagesize(v int) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["pagesize"] = v +} + +func (p *ListTemplateDirectDownloadCertificatesParams) GetPagesize() (int, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["pagesize"].(int) + return value, ok +} + +func (p *ListTemplateDirectDownloadCertificatesParams) SetZoneid(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["zoneid"] = v +} + +func (p *ListTemplateDirectDownloadCertificatesParams) 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 ListTemplateDirectDownloadCertificatesParams instance, +// as then you are sure you have configured all required params +func (s *TemplateService) NewListTemplateDirectDownloadCertificatesParams() *ListTemplateDirectDownloadCertificatesParams { + p := &ListTemplateDirectDownloadCertificatesParams{} + p.p = make(map[string]interface{}) + return p +} + +// This is a courtesy helper function, which in some cases may not work as expected! +func (s *TemplateService) GetTemplateDirectDownloadCertificateByID(id string, opts ...OptionFunc) (*TemplateDirectDownloadCertificate, int, error) { + p := &ListTemplateDirectDownloadCertificatesParams{} + p.p = make(map[string]interface{}) + + p.p["id"] = id + + for _, fn := range append(s.cs.options, opts...) { + if err := fn(s.cs, p); err != nil { + return nil, -1, err + } + } + + l, err := s.ListTemplateDirectDownloadCertificates(p) + if err != nil { + if strings.Contains(err.Error(), fmt.Sprintf( + "Invalid parameter id value=%s due to incorrect long value format, "+ + "or entity does not exist", id)) { + return nil, 0, fmt.Errorf("No match found for %s: %+v", id, l) + } + return nil, -1, err + } + + if l.Count == 0 { + return nil, l.Count, fmt.Errorf("No match found for %s: %+v", id, l) + } + + if l.Count == 1 { + return l.TemplateDirectDownloadCertificates[0], l.Count, nil + } + return nil, l.Count, fmt.Errorf("There is more then one result for TemplateDirectDownloadCertificate UUID: %s!", id) +} + +// List the uploaded certificates for direct download templates +func (s *TemplateService) ListTemplateDirectDownloadCertificates(p *ListTemplateDirectDownloadCertificatesParams) (*ListTemplateDirectDownloadCertificatesResponse, error) { + resp, err := s.cs.newRequest("listTemplateDirectDownloadCertificates", p.toURLValues()) + if err != nil { + return nil, err + } + + var r ListTemplateDirectDownloadCertificatesResponse + if err := json.Unmarshal(resp, &r); err != nil { + return nil, err + } + + return &r, nil +} + +type ListTemplateDirectDownloadCertificatesResponse struct { + Count int `json:"count"` + TemplateDirectDownloadCertificates []*TemplateDirectDownloadCertificate `json:"templatedirectdownloadcertificate"` +} + +type TemplateDirectDownloadCertificate struct { + Alias string `json:"alias"` + Hostsmap []string `json:"hostsmap"` + Hypervisor string `json:"hypervisor"` + Id string `json:"id"` + Issuer string `json:"issuer"` + JobID string `json:"jobid"` + Jobstatus int `json:"jobstatus"` + Serialnum string `json:"serialnum"` + Subject string `json:"subject"` + Validity string `json:"validity"` + Version string `json:"version"` + Zoneid string `json:"zoneid"` + Zonename string `json:"zonename"` +} + +type ProvisionTemplateDirectDownloadCertificateParams struct { + p map[string]interface{} +} + +func (p *ProvisionTemplateDirectDownloadCertificateParams) toURLValues() url.Values { + u := url.Values{} + if p.p == nil { + return u + } + if v, found := p.p["hostid"]; found { + u.Set("hostid", v.(string)) + } + if v, found := p.p["id"]; found { + u.Set("id", v.(string)) + } + return u +} + +func (p *ProvisionTemplateDirectDownloadCertificateParams) SetHostid(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["hostid"] = v +} + +func (p *ProvisionTemplateDirectDownloadCertificateParams) GetHostid() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["hostid"].(string) + return value, ok +} + +func (p *ProvisionTemplateDirectDownloadCertificateParams) SetId(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["id"] = v +} + +func (p *ProvisionTemplateDirectDownloadCertificateParams) GetId() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["id"].(string) + return value, ok +} + +// You should always use this function to get a new ProvisionTemplateDirectDownloadCertificateParams instance, +// as then you are sure you have configured all required params +func (s *TemplateService) NewProvisionTemplateDirectDownloadCertificateParams(hostid string, id string) *ProvisionTemplateDirectDownloadCertificateParams { + p := &ProvisionTemplateDirectDownloadCertificateParams{} + p.p = make(map[string]interface{}) + p.p["hostid"] = hostid + p.p["id"] = id + return p +} + +// Provisions a host with a direct download certificate +func (s *TemplateService) ProvisionTemplateDirectDownloadCertificate(p *ProvisionTemplateDirectDownloadCertificateParams) (*ProvisionTemplateDirectDownloadCertificateResponse, error) { + resp, err := s.cs.newRequest("provisionTemplateDirectDownloadCertificate", p.toURLValues()) + if err != nil { + return nil, err + } + + var r ProvisionTemplateDirectDownloadCertificateResponse + if err := json.Unmarshal(resp, &r); err != nil { + return nil, err + } + + return &r, nil +} + +type ProvisionTemplateDirectDownloadCertificateResponse struct { + Details string `json:"details"` + Hostid string `json:"hostid"` + Hostname string `json:"hostname"` + JobID string `json:"jobid"` + Jobstatus int `json:"jobstatus"` + Status string `json:"status"` +} diff --git a/cloudstack/TemplateService_mock.go b/cloudstack/TemplateService_mock.go index 1cbf7c6..01cadf7 100644 --- a/cloudstack/TemplateService_mock.go +++ b/cloudstack/TemplateService_mock.go @@ -154,6 +154,27 @@ func (mr *MockTemplateServiceIfaceMockRecorder) GetTemplateByName(name, template return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "GetTemplateByName", reflect.TypeOf((*MockTemplateServiceIface)(nil).GetTemplateByName), varargs...) } +// GetTemplateDirectDownloadCertificateByID mocks base method. +func (m *MockTemplateServiceIface) GetTemplateDirectDownloadCertificateByID(id string, opts ...OptionFunc) (*TemplateDirectDownloadCertificate, int, error) { + m.ctrl.T.Helper() + varargs := []interface{}{id} + for _, a := range opts { + varargs = append(varargs, a) + } + ret := m.ctrl.Call(m, "GetTemplateDirectDownloadCertificateByID", varargs...) + ret0, _ := ret[0].(*TemplateDirectDownloadCertificate) + ret1, _ := ret[1].(int) + ret2, _ := ret[2].(error) + return ret0, ret1, ret2 +} + +// GetTemplateDirectDownloadCertificateByID indicates an expected call of GetTemplateDirectDownloadCertificateByID. +func (mr *MockTemplateServiceIfaceMockRecorder) GetTemplateDirectDownloadCertificateByID(id interface{}, opts ...interface{}) *gomock.Call { + mr.mock.ctrl.T.Helper() + varargs := append([]interface{}{id}, opts...) + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "GetTemplateDirectDownloadCertificateByID", reflect.TypeOf((*MockTemplateServiceIface)(nil).GetTemplateDirectDownloadCertificateByID), varargs...) +} + // GetTemplateID mocks base method. func (m *MockTemplateServiceIface) GetTemplateID(name, templatefilter, zoneid string, opts ...OptionFunc) (string, int, error) { m.ctrl.T.Helper() @@ -211,6 +232,21 @@ func (mr *MockTemplateServiceIfaceMockRecorder) GetUploadParamsForTemplate(p int return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "GetUploadParamsForTemplate", reflect.TypeOf((*MockTemplateServiceIface)(nil).GetUploadParamsForTemplate), p) } +// ListTemplateDirectDownloadCertificates mocks base method. +func (m *MockTemplateServiceIface) ListTemplateDirectDownloadCertificates(p *ListTemplateDirectDownloadCertificatesParams) (*ListTemplateDirectDownloadCertificatesResponse, error) { + m.ctrl.T.Helper() + ret := m.ctrl.Call(m, "ListTemplateDirectDownloadCertificates", p) + ret0, _ := ret[0].(*ListTemplateDirectDownloadCertificatesResponse) + ret1, _ := ret[1].(error) + return ret0, ret1 +} + +// ListTemplateDirectDownloadCertificates indicates an expected call of ListTemplateDirectDownloadCertificates. +func (mr *MockTemplateServiceIfaceMockRecorder) ListTemplateDirectDownloadCertificates(p interface{}) *gomock.Call { + mr.mock.ctrl.T.Helper() + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "ListTemplateDirectDownloadCertificates", reflect.TypeOf((*MockTemplateServiceIface)(nil).ListTemplateDirectDownloadCertificates), p) +} + // ListTemplatePermissions mocks base method. func (m *MockTemplateServiceIface) ListTemplatePermissions(p *ListTemplatePermissionsParams) (*ListTemplatePermissionsResponse, error) { m.ctrl.T.Helper() @@ -311,6 +347,20 @@ func (mr *MockTemplateServiceIfaceMockRecorder) NewGetUploadParamsForTemplatePar return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "NewGetUploadParamsForTemplateParams", reflect.TypeOf((*MockTemplateServiceIface)(nil).NewGetUploadParamsForTemplateParams), displaytext, format, hypervisor, name, zoneid) } +// NewListTemplateDirectDownloadCertificatesParams mocks base method. +func (m *MockTemplateServiceIface) NewListTemplateDirectDownloadCertificatesParams() *ListTemplateDirectDownloadCertificatesParams { + m.ctrl.T.Helper() + ret := m.ctrl.Call(m, "NewListTemplateDirectDownloadCertificatesParams") + ret0, _ := ret[0].(*ListTemplateDirectDownloadCertificatesParams) + return ret0 +} + +// NewListTemplateDirectDownloadCertificatesParams indicates an expected call of NewListTemplateDirectDownloadCertificatesParams. +func (mr *MockTemplateServiceIfaceMockRecorder) NewListTemplateDirectDownloadCertificatesParams() *gomock.Call { + mr.mock.ctrl.T.Helper() + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "NewListTemplateDirectDownloadCertificatesParams", reflect.TypeOf((*MockTemplateServiceIface)(nil).NewListTemplateDirectDownloadCertificatesParams)) +} + // NewListTemplatePermissionsParams mocks base method. func (m *MockTemplateServiceIface) NewListTemplatePermissionsParams(id string) *ListTemplatePermissionsParams { m.ctrl.T.Helper() @@ -353,6 +403,20 @@ func (mr *MockTemplateServiceIfaceMockRecorder) NewPrepareTemplateParams(templat return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "NewPrepareTemplateParams", reflect.TypeOf((*MockTemplateServiceIface)(nil).NewPrepareTemplateParams), templateid, zoneid) } +// NewProvisionTemplateDirectDownloadCertificateParams mocks base method. +func (m *MockTemplateServiceIface) NewProvisionTemplateDirectDownloadCertificateParams(hostid, id string) *ProvisionTemplateDirectDownloadCertificateParams { + m.ctrl.T.Helper() + ret := m.ctrl.Call(m, "NewProvisionTemplateDirectDownloadCertificateParams", hostid, id) + ret0, _ := ret[0].(*ProvisionTemplateDirectDownloadCertificateParams) + return ret0 +} + +// NewProvisionTemplateDirectDownloadCertificateParams indicates an expected call of NewProvisionTemplateDirectDownloadCertificateParams. +func (mr *MockTemplateServiceIfaceMockRecorder) NewProvisionTemplateDirectDownloadCertificateParams(hostid, id interface{}) *gomock.Call { + mr.mock.ctrl.T.Helper() + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "NewProvisionTemplateDirectDownloadCertificateParams", reflect.TypeOf((*MockTemplateServiceIface)(nil).NewProvisionTemplateDirectDownloadCertificateParams), hostid, id) +} + // NewRegisterTemplateParams mocks base method. func (m *MockTemplateServiceIface) NewRegisterTemplateParams(displaytext, format, hypervisor, name, url string) *RegisterTemplateParams { m.ctrl.T.Helper() @@ -424,6 +488,21 @@ func (mr *MockTemplateServiceIfaceMockRecorder) PrepareTemplate(p interface{}) * return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "PrepareTemplate", reflect.TypeOf((*MockTemplateServiceIface)(nil).PrepareTemplate), p) } +// ProvisionTemplateDirectDownloadCertificate mocks base method. +func (m *MockTemplateServiceIface) ProvisionTemplateDirectDownloadCertificate(p *ProvisionTemplateDirectDownloadCertificateParams) (*ProvisionTemplateDirectDownloadCertificateResponse, error) { + m.ctrl.T.Helper() + ret := m.ctrl.Call(m, "ProvisionTemplateDirectDownloadCertificate", p) + ret0, _ := ret[0].(*ProvisionTemplateDirectDownloadCertificateResponse) + ret1, _ := ret[1].(error) + return ret0, ret1 +} + +// ProvisionTemplateDirectDownloadCertificate indicates an expected call of ProvisionTemplateDirectDownloadCertificate. +func (mr *MockTemplateServiceIfaceMockRecorder) ProvisionTemplateDirectDownloadCertificate(p interface{}) *gomock.Call { + mr.mock.ctrl.T.Helper() + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "ProvisionTemplateDirectDownloadCertificate", reflect.TypeOf((*MockTemplateServiceIface)(nil).ProvisionTemplateDirectDownloadCertificate), p) +} + // RegisterTemplate mocks base method. func (m *MockTemplateServiceIface) RegisterTemplate(p *RegisterTemplateParams) (*RegisterTemplateResponse, error) { m.ctrl.T.Helper() diff --git a/cloudstack/UsageService.go b/cloudstack/UsageService.go index 3e2315c..7662565 100644 --- a/cloudstack/UsageService.go +++ b/cloudstack/UsageService.go @@ -52,6 +52,8 @@ type UsageServiceIface interface { NewRemoveRawUsageRecordsParams(interval int) *RemoveRawUsageRecordsParams UpdateTrafficType(p *UpdateTrafficTypeParams) (*UpdateTrafficTypeResponse, error) NewUpdateTrafficTypeParams(id string) *UpdateTrafficTypeParams + ListUsageServerMetrics(p *ListUsageServerMetricsParams) (*ListUsageServerMetricsResponse, error) + NewListUsageServerMetricsParams() *ListUsageServerMetricsParams } type AddTrafficMonitorParams struct { @@ -1783,3 +1785,53 @@ type UpdateTrafficTypeResponse struct { Vmwarenetworklabel string `json:"vmwarenetworklabel"` Xennetworklabel string `json:"xennetworklabel"` } + +type ListUsageServerMetricsParams struct { + p map[string]interface{} +} + +func (p *ListUsageServerMetricsParams) toURLValues() url.Values { + u := url.Values{} + if p.p == nil { + return u + } + return u +} + +// You should always use this function to get a new ListUsageServerMetricsParams instance, +// as then you are sure you have configured all required params +func (s *UsageService) NewListUsageServerMetricsParams() *ListUsageServerMetricsParams { + p := &ListUsageServerMetricsParams{} + p.p = make(map[string]interface{}) + return p +} + +// Lists Usage Server metrics +func (s *UsageService) ListUsageServerMetrics(p *ListUsageServerMetricsParams) (*ListUsageServerMetricsResponse, error) { + resp, err := s.cs.newRequest("listUsageServerMetrics", p.toURLValues()) + if err != nil { + return nil, err + } + + var r ListUsageServerMetricsResponse + if err := json.Unmarshal(resp, &r); err != nil { + return nil, err + } + + return &r, nil +} + +type ListUsageServerMetricsResponse struct { + Count int `json:"count"` + UsageServerMetrics []*UsageServerMetric `json:"usageservermetric"` +} + +type UsageServerMetric struct { + Collectiontime string `json:"collectiontime"` + Hostname string `json:"hostname"` + JobID string `json:"jobid"` + Jobstatus int `json:"jobstatus"` + Lastheartbeat string `json:"lastheartbeat"` + Lastsuccessfuljob string `json:"lastsuccessfuljob"` + State string `json:"state"` +} diff --git a/cloudstack/UsageService_mock.go b/cloudstack/UsageService_mock.go index bcd55e4..9ff4854 100644 --- a/cloudstack/UsageService_mock.go +++ b/cloudstack/UsageService_mock.go @@ -208,6 +208,21 @@ func (mr *MockUsageServiceIfaceMockRecorder) ListUsageRecords(p interface{}) *go return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "ListUsageRecords", reflect.TypeOf((*MockUsageServiceIface)(nil).ListUsageRecords), p) } +// ListUsageServerMetrics mocks base method. +func (m *MockUsageServiceIface) ListUsageServerMetrics(p *ListUsageServerMetricsParams) (*ListUsageServerMetricsResponse, error) { + m.ctrl.T.Helper() + ret := m.ctrl.Call(m, "ListUsageServerMetrics", p) + ret0, _ := ret[0].(*ListUsageServerMetricsResponse) + ret1, _ := ret[1].(error) + return ret0, ret1 +} + +// ListUsageServerMetrics indicates an expected call of ListUsageServerMetrics. +func (mr *MockUsageServiceIfaceMockRecorder) ListUsageServerMetrics(p interface{}) *gomock.Call { + mr.mock.ctrl.T.Helper() + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "ListUsageServerMetrics", reflect.TypeOf((*MockUsageServiceIface)(nil).ListUsageServerMetrics), p) +} + // ListUsageTypes mocks base method. func (m *MockUsageServiceIface) ListUsageTypes(p *ListUsageTypesParams) (*ListUsageTypesResponse, error) { m.ctrl.T.Helper() @@ -349,6 +364,20 @@ func (mr *MockUsageServiceIfaceMockRecorder) NewListUsageRecordsParams(enddate, return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "NewListUsageRecordsParams", reflect.TypeOf((*MockUsageServiceIface)(nil).NewListUsageRecordsParams), enddate, startdate) } +// NewListUsageServerMetricsParams mocks base method. +func (m *MockUsageServiceIface) NewListUsageServerMetricsParams() *ListUsageServerMetricsParams { + m.ctrl.T.Helper() + ret := m.ctrl.Call(m, "NewListUsageServerMetricsParams") + ret0, _ := ret[0].(*ListUsageServerMetricsParams) + return ret0 +} + +// NewListUsageServerMetricsParams indicates an expected call of NewListUsageServerMetricsParams. +func (mr *MockUsageServiceIfaceMockRecorder) NewListUsageServerMetricsParams() *gomock.Call { + mr.mock.ctrl.T.Helper() + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "NewListUsageServerMetricsParams", reflect.TypeOf((*MockUsageServiceIface)(nil).NewListUsageServerMetricsParams)) +} + // NewListUsageTypesParams mocks base method. func (m *MockUsageServiceIface) NewListUsageTypesParams() *ListUsageTypesParams { m.ctrl.T.Helper() diff --git a/cloudstack/UserService.go b/cloudstack/UserService.go index b1f298e..246b33b 100644 --- a/cloudstack/UserService.go +++ b/cloudstack/UserService.go @@ -785,7 +785,7 @@ func (p *ListUsersParams) toURLValues() url.Values { u.Set("account", v.(string)) } if v, found := p.p["accounttype"]; found { - vv := strconv.FormatInt(v.(int64), 10) + vv := strconv.Itoa(v.(int)) u.Set("accounttype", vv) } if v, found := p.p["domainid"]; found { @@ -841,18 +841,18 @@ func (p *ListUsersParams) GetAccount() (string, bool) { return value, ok } -func (p *ListUsersParams) SetAccounttype(v int64) { +func (p *ListUsersParams) SetAccounttype(v int) { if p.p == nil { p.p = make(map[string]interface{}) } p.p["accounttype"] = v } -func (p *ListUsersParams) GetAccounttype() (int64, bool) { +func (p *ListUsersParams) GetAccounttype() (int, bool) { if p.p == nil { p.p = make(map[string]interface{}) } - value, ok := p.p["accounttype"].(int64) + value, ok := p.p["accounttype"].(int) return value, ok } diff --git a/cloudstack/VLANService.go b/cloudstack/VLANService.go index 6bba302..b85bb62 100644 --- a/cloudstack/VLANService.go +++ b/cloudstack/VLANService.go @@ -42,6 +42,8 @@ type VLANServiceIface interface { GetVlanIpRangeByID(id string, opts ...OptionFunc) (*VlanIpRange, int, error) ReleaseDedicatedGuestVlanRange(p *ReleaseDedicatedGuestVlanRangeParams) (*ReleaseDedicatedGuestVlanRangeResponse, error) NewReleaseDedicatedGuestVlanRangeParams(id string) *ReleaseDedicatedGuestVlanRangeParams + ListGuestVlans(p *ListGuestVlansParams) (*ListGuestVlansResponse, error) + NewListGuestVlansParams() *ListGuestVlansParams } type CreateVlanIpRangeParams struct { @@ -407,6 +409,7 @@ func (s *VLANService) CreateVlanIpRange(p *CreateVlanIpRangeParams) (*CreateVlan type CreateVlanIpRangeResponse struct { Account string `json:"account"` + Cidr string `json:"cidr"` Description string `json:"description"` Domain string `json:"domain"` Domainid string `json:"domainid"` @@ -1247,6 +1250,7 @@ type ListVlanIpRangesResponse struct { type VlanIpRange struct { Account string `json:"account"` + Cidr string `json:"cidr"` Description string `json:"description"` Domain string `json:"domain"` Domainid string `json:"domainid"` @@ -1348,3 +1352,211 @@ type ReleaseDedicatedGuestVlanRangeResponse struct { Jobstatus int `json:"jobstatus"` Success bool `json:"success"` } + +type ListGuestVlansParams struct { + p map[string]interface{} +} + +func (p *ListGuestVlansParams) toURLValues() url.Values { + u := url.Values{} + if p.p == nil { + return u + } + if v, found := p.p["allocatedonly"]; found { + vv := strconv.FormatBool(v.(bool)) + u.Set("allocatedonly", vv) + } + if v, found := p.p["id"]; found { + vv := strconv.FormatInt(v.(int64), 10) + u.Set("id", vv) + } + if v, found := p.p["keyword"]; found { + u.Set("keyword", v.(string)) + } + if v, found := p.p["page"]; found { + vv := strconv.Itoa(v.(int)) + u.Set("page", vv) + } + if v, found := p.p["pagesize"]; found { + vv := strconv.Itoa(v.(int)) + u.Set("pagesize", vv) + } + if v, found := p.p["physicalnetworkid"]; found { + u.Set("physicalnetworkid", v.(string)) + } + if v, found := p.p["vnet"]; found { + u.Set("vnet", v.(string)) + } + if v, found := p.p["zoneid"]; found { + u.Set("zoneid", v.(string)) + } + return u +} + +func (p *ListGuestVlansParams) SetAllocatedonly(v bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["allocatedonly"] = v +} + +func (p *ListGuestVlansParams) GetAllocatedonly() (bool, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["allocatedonly"].(bool) + return value, ok +} + +func (p *ListGuestVlansParams) SetId(v int64) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["id"] = v +} + +func (p *ListGuestVlansParams) GetId() (int64, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["id"].(int64) + return value, ok +} + +func (p *ListGuestVlansParams) SetKeyword(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["keyword"] = v +} + +func (p *ListGuestVlansParams) GetKeyword() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["keyword"].(string) + return value, ok +} + +func (p *ListGuestVlansParams) SetPage(v int) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["page"] = v +} + +func (p *ListGuestVlansParams) GetPage() (int, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["page"].(int) + return value, ok +} + +func (p *ListGuestVlansParams) SetPagesize(v int) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["pagesize"] = v +} + +func (p *ListGuestVlansParams) GetPagesize() (int, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["pagesize"].(int) + return value, ok +} + +func (p *ListGuestVlansParams) SetPhysicalnetworkid(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["physicalnetworkid"] = v +} + +func (p *ListGuestVlansParams) GetPhysicalnetworkid() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["physicalnetworkid"].(string) + return value, ok +} + +func (p *ListGuestVlansParams) SetVnet(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["vnet"] = v +} + +func (p *ListGuestVlansParams) GetVnet() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["vnet"].(string) + return value, ok +} + +func (p *ListGuestVlansParams) SetZoneid(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["zoneid"] = v +} + +func (p *ListGuestVlansParams) 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 ListGuestVlansParams instance, +// as then you are sure you have configured all required params +func (s *VLANService) NewListGuestVlansParams() *ListGuestVlansParams { + p := &ListGuestVlansParams{} + p.p = make(map[string]interface{}) + return p +} + +// Lists all guest vlans +func (s *VLANService) ListGuestVlans(p *ListGuestVlansParams) (*ListGuestVlansResponse, error) { + resp, err := s.cs.newRequest("listGuestVlans", p.toURLValues()) + if err != nil { + return nil, err + } + + var r ListGuestVlansResponse + if err := json.Unmarshal(resp, &r); err != nil { + return nil, err + } + + return &r, nil +} + +type ListGuestVlansResponse struct { + Count int `json:"count"` + GuestVlans []*GuestVlan `json:"guestvlan"` +} + +type GuestVlan struct { + Account string `json:"account"` + Allocationstate string `json:"allocationstate"` + Domain string `json:"domain"` + Domainid string `json:"domainid"` + Id int64 `json:"id"` + Isdedicated bool `json:"isdedicated"` + JobID string `json:"jobid"` + Jobstatus int `json:"jobstatus"` + Network []*Network `json:"network"` + Physicalnetworkid string `json:"physicalnetworkid"` + Physicalnetworkname string `json:"physicalnetworkname"` + Project string `json:"project"` + Projectid string `json:"projectid"` + Taken string `json:"taken"` + Vlan string `json:"vlan"` + Zoneid string `json:"zoneid"` + Zonename string `json:"zonename"` +} diff --git a/cloudstack/VLANService_mock.go b/cloudstack/VLANService_mock.go index 04ca582..9d9697e 100644 --- a/cloudstack/VLANService_mock.go +++ b/cloudstack/VLANService_mock.go @@ -154,6 +154,21 @@ func (mr *MockVLANServiceIfaceMockRecorder) ListDedicatedGuestVlanRanges(p inter return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "ListDedicatedGuestVlanRanges", reflect.TypeOf((*MockVLANServiceIface)(nil).ListDedicatedGuestVlanRanges), p) } +// ListGuestVlans mocks base method. +func (m *MockVLANServiceIface) ListGuestVlans(p *ListGuestVlansParams) (*ListGuestVlansResponse, error) { + m.ctrl.T.Helper() + ret := m.ctrl.Call(m, "ListGuestVlans", p) + ret0, _ := ret[0].(*ListGuestVlansResponse) + ret1, _ := ret[1].(error) + return ret0, ret1 +} + +// ListGuestVlans indicates an expected call of ListGuestVlans. +func (mr *MockVLANServiceIfaceMockRecorder) ListGuestVlans(p interface{}) *gomock.Call { + mr.mock.ctrl.T.Helper() + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "ListGuestVlans", reflect.TypeOf((*MockVLANServiceIface)(nil).ListGuestVlans), p) +} + // ListVlanIpRanges mocks base method. func (m *MockVLANServiceIface) ListVlanIpRanges(p *ListVlanIpRangesParams) (*ListVlanIpRangesResponse, error) { m.ctrl.T.Helper() @@ -225,6 +240,20 @@ func (mr *MockVLANServiceIfaceMockRecorder) NewListDedicatedGuestVlanRangesParam return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "NewListDedicatedGuestVlanRangesParams", reflect.TypeOf((*MockVLANServiceIface)(nil).NewListDedicatedGuestVlanRangesParams)) } +// NewListGuestVlansParams mocks base method. +func (m *MockVLANServiceIface) NewListGuestVlansParams() *ListGuestVlansParams { + m.ctrl.T.Helper() + ret := m.ctrl.Call(m, "NewListGuestVlansParams") + ret0, _ := ret[0].(*ListGuestVlansParams) + return ret0 +} + +// NewListGuestVlansParams indicates an expected call of NewListGuestVlansParams. +func (mr *MockVLANServiceIfaceMockRecorder) NewListGuestVlansParams() *gomock.Call { + mr.mock.ctrl.T.Helper() + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "NewListGuestVlansParams", reflect.TypeOf((*MockVLANServiceIface)(nil).NewListGuestVlansParams)) +} + // NewListVlanIpRangesParams mocks base method. func (m *MockVLANServiceIface) NewListVlanIpRangesParams() *ListVlanIpRangesParams { m.ctrl.T.Helper() diff --git a/cloudstack/VPCService.go b/cloudstack/VPCService.go index ec59228..1425d74 100644 --- a/cloudstack/VPCService.go +++ b/cloudstack/VPCService.go @@ -29,7 +29,7 @@ import ( type VPCServiceIface interface { CreatePrivateGateway(p *CreatePrivateGatewayParams) (*CreatePrivateGatewayResponse, error) - NewCreatePrivateGatewayParams(gateway string, ipaddress string, netmask string, vlan string, vpcid string) *CreatePrivateGatewayParams + NewCreatePrivateGatewayParams(gateway string, ipaddress string, netmask string, vpcid string) *CreatePrivateGatewayParams CreateStaticRoute(p *CreateStaticRouteParams) (*CreateStaticRouteResponse, error) NewCreateStaticRouteParams(cidr string, gatewayid string) *CreateStaticRouteParams CreateVPC(p *CreateVPCParams) (*CreateVPCResponse, error) @@ -80,6 +80,9 @@ func (p *CreatePrivateGatewayParams) toURLValues() url.Values { if v, found := p.p["aclid"]; found { u.Set("aclid", v.(string)) } + if v, found := p.p["associatednetworkid"]; found { + u.Set("associatednetworkid", v.(string)) + } if v, found := p.p["bypassvlanoverlapcheck"]; found { vv := strconv.FormatBool(v.(bool)) u.Set("bypassvlanoverlapcheck", vv) @@ -127,6 +130,21 @@ func (p *CreatePrivateGatewayParams) GetAclid() (string, bool) { return value, ok } +func (p *CreatePrivateGatewayParams) SetAssociatednetworkid(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["associatednetworkid"] = v +} + +func (p *CreatePrivateGatewayParams) GetAssociatednetworkid() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["associatednetworkid"].(string) + return value, ok +} + func (p *CreatePrivateGatewayParams) SetBypassvlanoverlapcheck(v bool) { if p.p == nil { p.p = make(map[string]interface{}) @@ -264,13 +282,12 @@ func (p *CreatePrivateGatewayParams) GetVpcid() (string, bool) { // You should always use this function to get a new CreatePrivateGatewayParams instance, // as then you are sure you have configured all required params -func (s *VPCService) NewCreatePrivateGatewayParams(gateway string, ipaddress string, netmask string, vlan string, vpcid string) *CreatePrivateGatewayParams { +func (s *VPCService) NewCreatePrivateGatewayParams(gateway string, ipaddress string, netmask string, vpcid string) *CreatePrivateGatewayParams { p := &CreatePrivateGatewayParams{} p.p = make(map[string]interface{}) p.p["gateway"] = gateway p.p["ipaddress"] = ipaddress p.p["netmask"] = netmask - p.p["vlan"] = vlan p.p["vpcid"] = vpcid return p } @@ -311,27 +328,30 @@ func (s *VPCService) CreatePrivateGateway(p *CreatePrivateGatewayParams) (*Creat } type CreatePrivateGatewayResponse struct { - Account string `json:"account"` - Aclid string `json:"aclid"` - Aclname string `json:"aclname"` - Domain string `json:"domain"` - Domainid string `json:"domainid"` - Gateway string `json:"gateway"` - Id string `json:"id"` - Ipaddress string `json:"ipaddress"` - JobID string `json:"jobid"` - Jobstatus int `json:"jobstatus"` - Netmask string `json:"netmask"` - Physicalnetworkid string `json:"physicalnetworkid"` - Project string `json:"project"` - Projectid string `json:"projectid"` - Sourcenatsupported bool `json:"sourcenatsupported"` - State string `json:"state"` - Vlan string `json:"vlan"` - Vpcid string `json:"vpcid"` - Vpcname string `json:"vpcname"` - Zoneid string `json:"zoneid"` - Zonename string `json:"zonename"` + Account string `json:"account"` + Aclid string `json:"aclid"` + Aclname string `json:"aclname"` + Associatednetwork string `json:"associatednetwork"` + Associatednetworkid string `json:"associatednetworkid"` + Domain string `json:"domain"` + Domainid string `json:"domainid"` + Gateway string `json:"gateway"` + Hasannotations bool `json:"hasannotations"` + Id string `json:"id"` + Ipaddress string `json:"ipaddress"` + JobID string `json:"jobid"` + Jobstatus int `json:"jobstatus"` + Netmask string `json:"netmask"` + Physicalnetworkid string `json:"physicalnetworkid"` + Project string `json:"project"` + Projectid string `json:"projectid"` + Sourcenatsupported bool `json:"sourcenatsupported"` + State string `json:"state"` + Vlan string `json:"vlan"` + Vpcid string `json:"vpcid"` + Vpcname string `json:"vpcname"` + Zoneid string `json:"zoneid"` + Zonename string `json:"zonename"` } type CreateStaticRouteParams struct { @@ -715,6 +735,7 @@ type CreateVPCResponse struct { Hasannotations bool `json:"hasannotations"` Icon interface{} `json:"icon"` Id string `json:"id"` + Ip6routes []interface{} `json:"ip6routes"` JobID string `json:"jobid"` Jobstatus int `json:"jobstatus"` Name string `json:"name"` @@ -776,6 +797,9 @@ func (p *CreateVPCOfferingParams) toURLValues() url.Values { vv := strconv.FormatBool(v.(bool)) u.Set("enable", vv) } + if v, found := p.p["internetprotocol"]; found { + u.Set("internetprotocol", v.(string)) + } if v, found := p.p["name"]; found { u.Set("name", v.(string)) } @@ -852,6 +876,21 @@ func (p *CreateVPCOfferingParams) GetEnable() (bool, bool) { return value, ok } +func (p *CreateVPCOfferingParams) SetInternetprotocol(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["internetprotocol"] = v +} + +func (p *CreateVPCOfferingParams) GetInternetprotocol() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["internetprotocol"].(string) + return value, ok +} + func (p *CreateVPCOfferingParams) SetName(v string) { if p.p == nil { p.p = make(map[string]interface{}) @@ -995,6 +1034,7 @@ type CreateVPCOfferingResponse struct { Domain string `json:"domain"` Domainid string `json:"domainid"` Id string `json:"id"` + Internetprotocol string `json:"internetprotocol"` Isdefault bool `json:"isdefault"` JobID string `json:"jobid"` Jobstatus int `json:"jobstatus"` @@ -1644,27 +1684,30 @@ type ListPrivateGatewaysResponse struct { } type PrivateGateway struct { - Account string `json:"account"` - Aclid string `json:"aclid"` - Aclname string `json:"aclname"` - Domain string `json:"domain"` - Domainid string `json:"domainid"` - Gateway string `json:"gateway"` - Id string `json:"id"` - Ipaddress string `json:"ipaddress"` - JobID string `json:"jobid"` - Jobstatus int `json:"jobstatus"` - Netmask string `json:"netmask"` - Physicalnetworkid string `json:"physicalnetworkid"` - Project string `json:"project"` - Projectid string `json:"projectid"` - Sourcenatsupported bool `json:"sourcenatsupported"` - State string `json:"state"` - Vlan string `json:"vlan"` - Vpcid string `json:"vpcid"` - Vpcname string `json:"vpcname"` - Zoneid string `json:"zoneid"` - Zonename string `json:"zonename"` + Account string `json:"account"` + Aclid string `json:"aclid"` + Aclname string `json:"aclname"` + Associatednetwork string `json:"associatednetwork"` + Associatednetworkid string `json:"associatednetworkid"` + Domain string `json:"domain"` + Domainid string `json:"domainid"` + Gateway string `json:"gateway"` + Hasannotations bool `json:"hasannotations"` + Id string `json:"id"` + Ipaddress string `json:"ipaddress"` + JobID string `json:"jobid"` + Jobstatus int `json:"jobstatus"` + Netmask string `json:"netmask"` + Physicalnetworkid string `json:"physicalnetworkid"` + Project string `json:"project"` + Projectid string `json:"projectid"` + Sourcenatsupported bool `json:"sourcenatsupported"` + State string `json:"state"` + Vlan string `json:"vlan"` + Vpcid string `json:"vpcid"` + Vpcname string `json:"vpcname"` + Zoneid string `json:"zoneid"` + Zonename string `json:"zonename"` } type ListStaticRoutesParams struct { @@ -2312,6 +2355,7 @@ type VPCOffering struct { Domain string `json:"domain"` Domainid string `json:"domainid"` Id string `json:"id"` + Internetprotocol string `json:"internetprotocol"` Isdefault bool `json:"isdefault"` JobID string `json:"jobid"` Jobstatus int `json:"jobstatus"` @@ -2852,6 +2896,7 @@ type VPC struct { Hasannotations bool `json:"hasannotations"` Icon interface{} `json:"icon"` Id string `json:"id"` + Ip6routes []interface{} `json:"ip6routes"` JobID string `json:"jobid"` Jobstatus int `json:"jobstatus"` Name string `json:"name"` @@ -2909,6 +2954,10 @@ func (p *RestartVPCParams) toURLValues() url.Values { if v, found := p.p["id"]; found { u.Set("id", v.(string)) } + if v, found := p.p["livepatch"]; found { + vv := strconv.FormatBool(v.(bool)) + u.Set("livepatch", vv) + } if v, found := p.p["makeredundant"]; found { vv := strconv.FormatBool(v.(bool)) u.Set("makeredundant", vv) @@ -2946,6 +2995,21 @@ func (p *RestartVPCParams) GetId() (string, bool) { return value, ok } +func (p *RestartVPCParams) SetLivepatch(v bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["livepatch"] = v +} + +func (p *RestartVPCParams) GetLivepatch() (bool, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["livepatch"].(bool) + return value, ok +} + func (p *RestartVPCParams) SetMakeredundant(v bool) { if p.p == nil { p.p = make(map[string]interface{}) @@ -3166,6 +3230,7 @@ type UpdateVPCResponse struct { Hasannotations bool `json:"hasannotations"` Icon interface{} `json:"icon"` Id string `json:"id"` + Ip6routes []interface{} `json:"ip6routes"` JobID string `json:"jobid"` Jobstatus int `json:"jobstatus"` Name string `json:"name"` @@ -3397,6 +3462,7 @@ type UpdateVPCOfferingResponse struct { Domain string `json:"domain"` Domainid string `json:"domainid"` Id string `json:"id"` + Internetprotocol string `json:"internetprotocol"` Isdefault bool `json:"isdefault"` JobID string `json:"jobid"` Jobstatus int `json:"jobstatus"` diff --git a/cloudstack/VPCService_mock.go b/cloudstack/VPCService_mock.go index ae219c7..33dde55 100644 --- a/cloudstack/VPCService_mock.go +++ b/cloudstack/VPCService_mock.go @@ -401,17 +401,17 @@ func (mr *MockVPCServiceIfaceMockRecorder) ListVPCs(p interface{}) *gomock.Call } // NewCreatePrivateGatewayParams mocks base method. -func (m *MockVPCServiceIface) NewCreatePrivateGatewayParams(gateway, ipaddress, netmask, vlan, vpcid string) *CreatePrivateGatewayParams { +func (m *MockVPCServiceIface) NewCreatePrivateGatewayParams(gateway, ipaddress, netmask, vpcid string) *CreatePrivateGatewayParams { m.ctrl.T.Helper() - ret := m.ctrl.Call(m, "NewCreatePrivateGatewayParams", gateway, ipaddress, netmask, vlan, vpcid) + ret := m.ctrl.Call(m, "NewCreatePrivateGatewayParams", gateway, ipaddress, netmask, vpcid) ret0, _ := ret[0].(*CreatePrivateGatewayParams) return ret0 } // NewCreatePrivateGatewayParams indicates an expected call of NewCreatePrivateGatewayParams. -func (mr *MockVPCServiceIfaceMockRecorder) NewCreatePrivateGatewayParams(gateway, ipaddress, netmask, vlan, vpcid interface{}) *gomock.Call { +func (mr *MockVPCServiceIfaceMockRecorder) NewCreatePrivateGatewayParams(gateway, ipaddress, netmask, vpcid interface{}) *gomock.Call { mr.mock.ctrl.T.Helper() - return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "NewCreatePrivateGatewayParams", reflect.TypeOf((*MockVPCServiceIface)(nil).NewCreatePrivateGatewayParams), gateway, ipaddress, netmask, vlan, vpcid) + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "NewCreatePrivateGatewayParams", reflect.TypeOf((*MockVPCServiceIface)(nil).NewCreatePrivateGatewayParams), gateway, ipaddress, netmask, vpcid) } // NewCreateStaticRouteParams mocks base method. diff --git a/cloudstack/VirtualMachineService.go b/cloudstack/VirtualMachineService.go index 2bac76c..2386d13 100644 --- a/cloudstack/VirtualMachineService.go +++ b/cloudstack/VirtualMachineService.go @@ -78,6 +78,11 @@ type VirtualMachineServiceIface interface { NewUpdateDefaultNicForVirtualMachineParams(nicid string, virtualmachineid string) *UpdateDefaultNicForVirtualMachineParams UpdateVirtualMachine(p *UpdateVirtualMachineParams) (*UpdateVirtualMachineResponse, error) NewUpdateVirtualMachineParams(id string) *UpdateVirtualMachineParams + ListVirtualMachinesUsageHistory(p *ListVirtualMachinesUsageHistoryParams) (*ListVirtualMachinesUsageHistoryResponse, error) + NewListVirtualMachinesUsageHistoryParams() *ListVirtualMachinesUsageHistoryParams + GetVirtualMachinesUsageHistoryID(name string, opts ...OptionFunc) (string, int, error) + GetVirtualMachinesUsageHistoryByName(name string, opts ...OptionFunc) (*VirtualMachinesUsageHistory, int, error) + GetVirtualMachinesUsageHistoryByID(id string, opts ...OptionFunc) (*VirtualMachinesUsageHistory, int, error) } type AddNicToVirtualMachineParams struct { @@ -271,7 +276,7 @@ type AddNicToVirtualMachineResponse struct { Isoname string `json:"isoname"` JobID string `json:"jobid"` Jobstatus int `json:"jobstatus"` - Keypair string `json:"keypair"` + Keypairs string `json:"keypairs"` Lastupdated string `json:"lastupdated"` Memory int `json:"memory"` Memoryintfreekbs int64 `json:"memoryintfreekbs"` @@ -566,7 +571,7 @@ type AssignVirtualMachineResponse struct { Isoname string `json:"isoname"` JobID string `json:"jobid"` Jobstatus int `json:"jobstatus"` - Keypair string `json:"keypair"` + Keypairs string `json:"keypairs"` Lastupdated string `json:"lastupdated"` Memory int `json:"memory"` Memoryintfreekbs int64 `json:"memoryintfreekbs"` @@ -684,6 +689,10 @@ func (p *ChangeServiceForVirtualMachineParams) toURLValues() url.Values { if p.p == nil { return u } + if v, found := p.p["automigrate"]; found { + vv := strconv.FormatBool(v.(bool)) + u.Set("automigrate", vv) + } if v, found := p.p["details"]; found { m := v.(map[string]string) for i, k := range getSortedKeysFromMap(m) { @@ -693,12 +702,39 @@ func (p *ChangeServiceForVirtualMachineParams) toURLValues() url.Values { if v, found := p.p["id"]; found { u.Set("id", v.(string)) } + if v, found := p.p["maxiops"]; found { + vv := strconv.FormatInt(v.(int64), 10) + u.Set("maxiops", vv) + } + if v, found := p.p["miniops"]; found { + vv := strconv.FormatInt(v.(int64), 10) + u.Set("miniops", vv) + } if v, found := p.p["serviceofferingid"]; found { u.Set("serviceofferingid", v.(string)) } + if v, found := p.p["shrinkok"]; found { + vv := strconv.FormatBool(v.(bool)) + u.Set("shrinkok", vv) + } return u } +func (p *ChangeServiceForVirtualMachineParams) SetAutomigrate(v bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["automigrate"] = v +} + +func (p *ChangeServiceForVirtualMachineParams) GetAutomigrate() (bool, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["automigrate"].(bool) + return value, ok +} + func (p *ChangeServiceForVirtualMachineParams) SetDetails(v map[string]string) { if p.p == nil { p.p = make(map[string]interface{}) @@ -729,6 +765,36 @@ func (p *ChangeServiceForVirtualMachineParams) GetId() (string, bool) { return value, ok } +func (p *ChangeServiceForVirtualMachineParams) SetMaxiops(v int64) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["maxiops"] = v +} + +func (p *ChangeServiceForVirtualMachineParams) GetMaxiops() (int64, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["maxiops"].(int64) + return value, ok +} + +func (p *ChangeServiceForVirtualMachineParams) SetMiniops(v int64) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["miniops"] = v +} + +func (p *ChangeServiceForVirtualMachineParams) GetMiniops() (int64, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["miniops"].(int64) + return value, ok +} + func (p *ChangeServiceForVirtualMachineParams) SetServiceofferingid(v string) { if p.p == nil { p.p = make(map[string]interface{}) @@ -744,6 +810,21 @@ func (p *ChangeServiceForVirtualMachineParams) GetServiceofferingid() (string, b return value, ok } +func (p *ChangeServiceForVirtualMachineParams) SetShrinkok(v bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["shrinkok"] = v +} + +func (p *ChangeServiceForVirtualMachineParams) GetShrinkok() (bool, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["shrinkok"].(bool) + return value, ok +} + // You should always use this function to get a new ChangeServiceForVirtualMachineParams instance, // as then you are sure you have configured all required params func (s *VirtualMachineService) NewChangeServiceForVirtualMachineParams(id string, serviceofferingid string) *ChangeServiceForVirtualMachineParams { @@ -809,7 +890,7 @@ type ChangeServiceForVirtualMachineResponse struct { Isoname string `json:"isoname"` JobID string `json:"jobid"` Jobstatus int `json:"jobstatus"` - Keypair string `json:"keypair"` + Keypairs string `json:"keypairs"` Lastupdated string `json:"lastupdated"` Memory int `json:"memory"` Memoryintfreekbs int64 `json:"memoryintfreekbs"` @@ -1088,6 +1169,10 @@ func (p *DeployVirtualMachineParams) toURLValues() url.Values { if v, found := p.p["keypair"]; found { u.Set("keypair", v.(string)) } + if v, found := p.p["keypairs"]; found { + vv := strings.Join(v.([]string), ",") + u.Set("keypairs", vv) + } if v, found := p.p["macaddress"]; found { u.Set("macaddress", v.(string)) } @@ -1106,6 +1191,9 @@ func (p *DeployVirtualMachineParams) toURLValues() url.Values { } } } + if v, found := p.p["overridediskofferingid"]; found { + u.Set("overridediskofferingid", v.(string)) + } if v, found := p.p["podid"]; found { u.Set("podid", v.(string)) } @@ -1587,6 +1675,21 @@ func (p *DeployVirtualMachineParams) GetKeypair() (string, bool) { return value, ok } +func (p *DeployVirtualMachineParams) SetKeypairs(v []string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["keypairs"] = v +} + +func (p *DeployVirtualMachineParams) GetKeypairs() ([]string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["keypairs"].([]string) + return value, ok +} + func (p *DeployVirtualMachineParams) SetMacaddress(v string) { if p.p == nil { p.p = make(map[string]interface{}) @@ -1661,6 +1764,21 @@ func (p *DeployVirtualMachineParams) AddNicnetworklist(item map[string]string) { p.p["nicnetworklist"] = l } +func (p *DeployVirtualMachineParams) SetOverridediskofferingid(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["overridediskofferingid"] = v +} + +func (p *DeployVirtualMachineParams) GetOverridediskofferingid() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["overridediskofferingid"].(string) + return value, ok +} + func (p *DeployVirtualMachineParams) SetPodid(v string) { if p.p == nil { p.p = make(map[string]interface{}) @@ -1927,7 +2045,7 @@ type DeployVirtualMachineResponse struct { Isoname string `json:"isoname"` JobID string `json:"jobid"` Jobstatus int `json:"jobstatus"` - Keypair string `json:"keypair"` + Keypairs string `json:"keypairs"` Lastupdated string `json:"lastupdated"` Memory int `json:"memory"` Memoryintfreekbs int64 `json:"memoryintfreekbs"` @@ -2188,7 +2306,7 @@ type DestroyVirtualMachineResponse struct { Isoname string `json:"isoname"` JobID string `json:"jobid"` Jobstatus int `json:"jobstatus"` - Keypair string `json:"keypair"` + Keypairs string `json:"keypairs"` Lastupdated string `json:"lastupdated"` Memory int `json:"memory"` Memoryintfreekbs int64 `json:"memoryintfreekbs"` @@ -2445,9 +2563,16 @@ func (p *ListVirtualMachinesParams) toURLValues() url.Values { if v, found := p.p["account"]; found { u.Set("account", v.(string)) } + if v, found := p.p["accumulate"]; found { + vv := strconv.FormatBool(v.(bool)) + u.Set("accumulate", vv) + } if v, found := p.p["affinitygroupid"]; found { u.Set("affinitygroupid", v.(string)) } + if v, found := p.p["backupofferingid"]; found { + u.Set("backupofferingid", v.(string)) + } if v, found := p.p["clusterid"]; found { u.Set("clusterid", v.(string)) } @@ -2476,9 +2601,6 @@ func (p *ListVirtualMachinesParams) toURLValues() url.Values { if v, found := p.p["hostid"]; found { u.Set("hostid", v.(string)) } - if v, found := p.p["hostid"]; found { - u.Set("hostid", v.(string)) - } if v, found := p.p["hypervisor"]; found { u.Set("hypervisor", v.(string)) } @@ -2523,9 +2645,6 @@ func (p *ListVirtualMachinesParams) toURLValues() url.Values { if v, found := p.p["podid"]; found { u.Set("podid", v.(string)) } - if v, found := p.p["podid"]; found { - u.Set("podid", v.(string)) - } if v, found := p.p["projectid"]; found { u.Set("projectid", v.(string)) } @@ -2545,9 +2664,6 @@ func (p *ListVirtualMachinesParams) toURLValues() url.Values { if v, found := p.p["storageid"]; found { u.Set("storageid", 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) { @@ -2585,6 +2701,21 @@ func (p *ListVirtualMachinesParams) GetAccount() (string, bool) { return value, ok } +func (p *ListVirtualMachinesParams) SetAccumulate(v bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["accumulate"] = v +} + +func (p *ListVirtualMachinesParams) GetAccumulate() (bool, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["accumulate"].(bool) + return value, ok +} + func (p *ListVirtualMachinesParams) SetAffinitygroupid(v string) { if p.p == nil { p.p = make(map[string]interface{}) @@ -2600,6 +2731,21 @@ func (p *ListVirtualMachinesParams) GetAffinitygroupid() (string, bool) { return value, ok } +func (p *ListVirtualMachinesParams) SetBackupofferingid(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["backupofferingid"] = v +} + +func (p *ListVirtualMachinesParams) GetBackupofferingid() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["backupofferingid"].(string) + return value, ok +} + func (p *ListVirtualMachinesParams) SetClusterid(v string) { if p.p == nil { p.p = make(map[string]interface{}) @@ -3231,7 +3377,7 @@ type VirtualMachine struct { Isoname string `json:"isoname"` JobID string `json:"jobid"` Jobstatus int `json:"jobstatus"` - Keypair string `json:"keypair"` + Keypairs string `json:"keypairs"` Lastupdated string `json:"lastupdated"` Memory int `json:"memory"` Memoryintfreekbs int64 `json:"memoryintfreekbs"` @@ -3352,9 +3498,19 @@ func (p *ListVirtualMachinesMetricsParams) toURLValues() url.Values { if v, found := p.p["account"]; found { u.Set("account", v.(string)) } + if v, found := p.p["accumulate"]; found { + vv := strconv.FormatBool(v.(bool)) + u.Set("accumulate", vv) + } if v, found := p.p["affinitygroupid"]; found { u.Set("affinitygroupid", v.(string)) } + if v, found := p.p["backupofferingid"]; found { + u.Set("backupofferingid", v.(string)) + } + if v, found := p.p["clusterid"]; found { + u.Set("clusterid", v.(string)) + } if v, found := p.p["details"]; found { vv := strings.Join(v.([]string), ",") u.Set("details", vv) @@ -3480,6 +3636,21 @@ func (p *ListVirtualMachinesMetricsParams) GetAccount() (string, bool) { return value, ok } +func (p *ListVirtualMachinesMetricsParams) SetAccumulate(v bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["accumulate"] = v +} + +func (p *ListVirtualMachinesMetricsParams) GetAccumulate() (bool, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["accumulate"].(bool) + return value, ok +} + func (p *ListVirtualMachinesMetricsParams) SetAffinitygroupid(v string) { if p.p == nil { p.p = make(map[string]interface{}) @@ -3495,6 +3666,36 @@ func (p *ListVirtualMachinesMetricsParams) GetAffinitygroupid() (string, bool) { return value, ok } +func (p *ListVirtualMachinesMetricsParams) SetBackupofferingid(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["backupofferingid"] = v +} + +func (p *ListVirtualMachinesMetricsParams) GetBackupofferingid() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["backupofferingid"].(string) + return value, ok +} + +func (p *ListVirtualMachinesMetricsParams) SetClusterid(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["clusterid"] = v +} + +func (p *ListVirtualMachinesMetricsParams) GetClusterid() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["clusterid"].(string) + return value, ok +} + func (p *ListVirtualMachinesMetricsParams) SetDetails(v []string) { if p.p == nil { p.p = make(map[string]interface{}) @@ -4116,7 +4317,7 @@ type VirtualMachinesMetric struct { Isoname string `json:"isoname"` JobID string `json:"jobid"` Jobstatus int `json:"jobstatus"` - Keypair string `json:"keypair"` + Keypairs string `json:"keypairs"` Lastupdated string `json:"lastupdated"` Memory int `json:"memory"` Memoryintfreekbs int64 `json:"memoryintfreekbs"` @@ -4397,7 +4598,7 @@ type MigrateVirtualMachineResponse struct { Isoname string `json:"isoname"` JobID string `json:"jobid"` Jobstatus int `json:"jobstatus"` - Keypair string `json:"keypair"` + Keypairs string `json:"keypairs"` Lastupdated string `json:"lastupdated"` Memory int `json:"memory"` Memoryintfreekbs int64 `json:"memoryintfreekbs"` @@ -4675,7 +4876,7 @@ type MigrateVirtualMachineWithVolumeResponse struct { Isoname string `json:"isoname"` JobID string `json:"jobid"` Jobstatus int `json:"jobstatus"` - Keypair string `json:"keypair"` + Keypairs string `json:"keypairs"` Lastupdated string `json:"lastupdated"` Memory int `json:"memory"` Memoryintfreekbs int64 `json:"memoryintfreekbs"` @@ -4936,7 +5137,7 @@ type RebootVirtualMachineResponse struct { Isoname string `json:"isoname"` JobID string `json:"jobid"` Jobstatus int `json:"jobstatus"` - Keypair string `json:"keypair"` + Keypairs string `json:"keypairs"` Lastupdated string `json:"lastupdated"` Memory int `json:"memory"` Memoryintfreekbs int64 `json:"memoryintfreekbs"` @@ -5139,7 +5340,7 @@ type RecoverVirtualMachineResponse struct { Isoname string `json:"isoname"` JobID string `json:"jobid"` Jobstatus int `json:"jobstatus"` - Keypair string `json:"keypair"` + Keypairs string `json:"keypairs"` Lastupdated string `json:"lastupdated"` Memory int `json:"memory"` Memoryintfreekbs int64 `json:"memoryintfreekbs"` @@ -5381,7 +5582,7 @@ type RemoveNicFromVirtualMachineResponse struct { Isoname string `json:"isoname"` JobID string `json:"jobid"` Jobstatus int `json:"jobstatus"` - Keypair string `json:"keypair"` + Keypairs string `json:"keypairs"` Lastupdated string `json:"lastupdated"` Memory int `json:"memory"` Memoryintfreekbs int64 `json:"memoryintfreekbs"` @@ -5604,7 +5805,7 @@ type ResetPasswordForVirtualMachineResponse struct { Isoname string `json:"isoname"` JobID string `json:"jobid"` Jobstatus int `json:"jobstatus"` - Keypair string `json:"keypair"` + Keypairs string `json:"keypairs"` Lastupdated string `json:"lastupdated"` Memory int `json:"memory"` Memoryintfreekbs int64 `json:"memoryintfreekbs"` @@ -5845,7 +6046,7 @@ type RestoreVirtualMachineResponse struct { Isoname string `json:"isoname"` JobID string `json:"jobid"` Jobstatus int `json:"jobstatus"` - Keypair string `json:"keypair"` + Keypairs string `json:"keypairs"` Lastupdated string `json:"lastupdated"` Memory int `json:"memory"` Memoryintfreekbs int64 `json:"memoryintfreekbs"` @@ -5963,6 +6164,10 @@ func (p *ScaleVirtualMachineParams) toURLValues() url.Values { if p.p == nil { return u } + if v, found := p.p["automigrate"]; found { + vv := strconv.FormatBool(v.(bool)) + u.Set("automigrate", vv) + } if v, found := p.p["details"]; found { m := v.(map[string]string) for i, k := range getSortedKeysFromMap(m) { @@ -5972,12 +6177,39 @@ func (p *ScaleVirtualMachineParams) toURLValues() url.Values { if v, found := p.p["id"]; found { u.Set("id", v.(string)) } + if v, found := p.p["maxiops"]; found { + vv := strconv.FormatInt(v.(int64), 10) + u.Set("maxiops", vv) + } + if v, found := p.p["miniops"]; found { + vv := strconv.FormatInt(v.(int64), 10) + u.Set("miniops", vv) + } if v, found := p.p["serviceofferingid"]; found { u.Set("serviceofferingid", v.(string)) } + if v, found := p.p["shrinkok"]; found { + vv := strconv.FormatBool(v.(bool)) + u.Set("shrinkok", vv) + } return u } +func (p *ScaleVirtualMachineParams) SetAutomigrate(v bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["automigrate"] = v +} + +func (p *ScaleVirtualMachineParams) GetAutomigrate() (bool, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["automigrate"].(bool) + return value, ok +} + func (p *ScaleVirtualMachineParams) SetDetails(v map[string]string) { if p.p == nil { p.p = make(map[string]interface{}) @@ -6008,6 +6240,36 @@ func (p *ScaleVirtualMachineParams) GetId() (string, bool) { return value, ok } +func (p *ScaleVirtualMachineParams) SetMaxiops(v int64) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["maxiops"] = v +} + +func (p *ScaleVirtualMachineParams) GetMaxiops() (int64, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["maxiops"].(int64) + return value, ok +} + +func (p *ScaleVirtualMachineParams) SetMiniops(v int64) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["miniops"] = v +} + +func (p *ScaleVirtualMachineParams) GetMiniops() (int64, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["miniops"].(int64) + return value, ok +} + func (p *ScaleVirtualMachineParams) SetServiceofferingid(v string) { if p.p == nil { p.p = make(map[string]interface{}) @@ -6023,6 +6285,21 @@ func (p *ScaleVirtualMachineParams) GetServiceofferingid() (string, bool) { return value, ok } +func (p *ScaleVirtualMachineParams) SetShrinkok(v bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["shrinkok"] = v +} + +func (p *ScaleVirtualMachineParams) GetShrinkok() (bool, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["shrinkok"].(bool) + return value, ok +} + // You should always use this function to get a new ScaleVirtualMachineParams instance, // as then you are sure you have configured all required params func (s *VirtualMachineService) NewScaleVirtualMachineParams(id string, serviceofferingid string) *ScaleVirtualMachineParams { @@ -6275,7 +6552,7 @@ type StartVirtualMachineResponse struct { Isoname string `json:"isoname"` JobID string `json:"jobid"` Jobstatus int `json:"jobstatus"` - Keypair string `json:"keypair"` + Keypairs string `json:"keypairs"` Lastupdated string `json:"lastupdated"` Memory int `json:"memory"` Memoryintfreekbs int64 `json:"memoryintfreekbs"` @@ -6517,7 +6794,7 @@ type StopVirtualMachineResponse struct { Isoname string `json:"isoname"` JobID string `json:"jobid"` Jobstatus int `json:"jobstatus"` - Keypair string `json:"keypair"` + Keypairs string `json:"keypairs"` Lastupdated string `json:"lastupdated"` Memory int `json:"memory"` Memoryintfreekbs int64 `json:"memoryintfreekbs"` @@ -6759,7 +7036,7 @@ type UpdateDefaultNicForVirtualMachineResponse struct { Isoname string `json:"isoname"` JobID string `json:"jobid"` Jobstatus int `json:"jobstatus"` - Keypair string `json:"keypair"` + Keypairs string `json:"keypairs"` Lastupdated string `json:"lastupdated"` Memory int `json:"memory"` Memoryintfreekbs int64 `json:"memoryintfreekbs"` @@ -7278,7 +7555,7 @@ type UpdateVirtualMachineResponse struct { Isoname string `json:"isoname"` JobID string `json:"jobid"` Jobstatus int `json:"jobstatus"` - Keypair string `json:"keypair"` + Keypairs string `json:"keypairs"` Lastupdated string `json:"lastupdated"` Memory int `json:"memory"` Memoryintfreekbs int64 `json:"memoryintfreekbs"` @@ -7386,3 +7663,282 @@ func (r *UpdateVirtualMachineResponse) UnmarshalJSON(b []byte) error { type alias UpdateVirtualMachineResponse return json.Unmarshal(b, (*alias)(r)) } + +type ListVirtualMachinesUsageHistoryParams struct { + p map[string]interface{} +} + +func (p *ListVirtualMachinesUsageHistoryParams) toURLValues() url.Values { + u := url.Values{} + if p.p == nil { + return u + } + if v, found := p.p["enddate"]; found { + u.Set("enddate", v.(string)) + } + if v, found := p.p["id"]; found { + u.Set("id", v.(string)) + } + if v, found := p.p["ids"]; found { + vv := strings.Join(v.([]string), ",") + u.Set("ids", vv) + } + if v, found := p.p["keyword"]; found { + u.Set("keyword", v.(string)) + } + if v, found := p.p["name"]; found { + u.Set("name", v.(string)) + } + if v, found := p.p["page"]; found { + vv := strconv.Itoa(v.(int)) + u.Set("page", vv) + } + if v, found := p.p["pagesize"]; found { + vv := strconv.Itoa(v.(int)) + u.Set("pagesize", vv) + } + if v, found := p.p["startdate"]; found { + u.Set("startdate", v.(string)) + } + return u +} + +func (p *ListVirtualMachinesUsageHistoryParams) SetEnddate(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["enddate"] = v +} + +func (p *ListVirtualMachinesUsageHistoryParams) GetEnddate() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["enddate"].(string) + return value, ok +} + +func (p *ListVirtualMachinesUsageHistoryParams) SetId(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["id"] = v +} + +func (p *ListVirtualMachinesUsageHistoryParams) GetId() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["id"].(string) + return value, ok +} + +func (p *ListVirtualMachinesUsageHistoryParams) SetIds(v []string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["ids"] = v +} + +func (p *ListVirtualMachinesUsageHistoryParams) GetIds() ([]string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["ids"].([]string) + return value, ok +} + +func (p *ListVirtualMachinesUsageHistoryParams) SetKeyword(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["keyword"] = v +} + +func (p *ListVirtualMachinesUsageHistoryParams) GetKeyword() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["keyword"].(string) + return value, ok +} + +func (p *ListVirtualMachinesUsageHistoryParams) SetName(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["name"] = v +} + +func (p *ListVirtualMachinesUsageHistoryParams) GetName() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["name"].(string) + return value, ok +} + +func (p *ListVirtualMachinesUsageHistoryParams) SetPage(v int) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["page"] = v +} + +func (p *ListVirtualMachinesUsageHistoryParams) GetPage() (int, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["page"].(int) + return value, ok +} + +func (p *ListVirtualMachinesUsageHistoryParams) SetPagesize(v int) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["pagesize"] = v +} + +func (p *ListVirtualMachinesUsageHistoryParams) GetPagesize() (int, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["pagesize"].(int) + return value, ok +} + +func (p *ListVirtualMachinesUsageHistoryParams) SetStartdate(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["startdate"] = v +} + +func (p *ListVirtualMachinesUsageHistoryParams) GetStartdate() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["startdate"].(string) + return value, ok +} + +// You should always use this function to get a new ListVirtualMachinesUsageHistoryParams instance, +// as then you are sure you have configured all required params +func (s *VirtualMachineService) NewListVirtualMachinesUsageHistoryParams() *ListVirtualMachinesUsageHistoryParams { + p := &ListVirtualMachinesUsageHistoryParams{} + p.p = make(map[string]interface{}) + return p +} + +// This is a courtesy helper function, which in some cases may not work as expected! +func (s *VirtualMachineService) GetVirtualMachinesUsageHistoryID(name string, opts ...OptionFunc) (string, int, error) { + p := &ListVirtualMachinesUsageHistoryParams{} + p.p = make(map[string]interface{}) + + p.p["name"] = name + + for _, fn := range append(s.cs.options, opts...) { + if err := fn(s.cs, p); err != nil { + return "", -1, err + } + } + + l, err := s.ListVirtualMachinesUsageHistory(p) + if err != nil { + return "", -1, err + } + + if l.Count == 0 { + return "", l.Count, fmt.Errorf("No match found for %s: %+v", name, l) + } + + if l.Count == 1 { + return l.VirtualMachinesUsageHistory[0].Id, l.Count, nil + } + + if l.Count > 1 { + for _, v := range l.VirtualMachinesUsageHistory { + if v.Name == name { + return v.Id, l.Count, nil + } + } + } + return "", l.Count, fmt.Errorf("Could not find an exact match for %s: %+v", name, l) +} + +// This is a courtesy helper function, which in some cases may not work as expected! +func (s *VirtualMachineService) GetVirtualMachinesUsageHistoryByName(name string, opts ...OptionFunc) (*VirtualMachinesUsageHistory, int, error) { + id, count, err := s.GetVirtualMachinesUsageHistoryID(name, opts...) + if err != nil { + return nil, count, err + } + + r, count, err := s.GetVirtualMachinesUsageHistoryByID(id, opts...) + if err != nil { + return nil, count, err + } + return r, count, nil +} + +// This is a courtesy helper function, which in some cases may not work as expected! +func (s *VirtualMachineService) GetVirtualMachinesUsageHistoryByID(id string, opts ...OptionFunc) (*VirtualMachinesUsageHistory, int, error) { + p := &ListVirtualMachinesUsageHistoryParams{} + p.p = make(map[string]interface{}) + + p.p["id"] = id + + for _, fn := range append(s.cs.options, opts...) { + if err := fn(s.cs, p); err != nil { + return nil, -1, err + } + } + + l, err := s.ListVirtualMachinesUsageHistory(p) + if err != nil { + if strings.Contains(err.Error(), fmt.Sprintf( + "Invalid parameter id value=%s due to incorrect long value format, "+ + "or entity does not exist", id)) { + return nil, 0, fmt.Errorf("No match found for %s: %+v", id, l) + } + return nil, -1, err + } + + if l.Count == 0 { + return nil, l.Count, fmt.Errorf("No match found for %s: %+v", id, l) + } + + if l.Count == 1 { + return l.VirtualMachinesUsageHistory[0], l.Count, nil + } + return nil, l.Count, fmt.Errorf("There is more then one result for VirtualMachinesUsageHistory UUID: %s!", id) +} + +// Lists VM stats +func (s *VirtualMachineService) ListVirtualMachinesUsageHistory(p *ListVirtualMachinesUsageHistoryParams) (*ListVirtualMachinesUsageHistoryResponse, error) { + resp, err := s.cs.newRequest("listVirtualMachinesUsageHistory", p.toURLValues()) + if err != nil { + return nil, err + } + + var r ListVirtualMachinesUsageHistoryResponse + if err := json.Unmarshal(resp, &r); err != nil { + return nil, err + } + + return &r, nil +} + +type ListVirtualMachinesUsageHistoryResponse struct { + Count int `json:"count"` + VirtualMachinesUsageHistory []*VirtualMachinesUsageHistory `json:"virtualmachinesusagehistory"` +} + +type VirtualMachinesUsageHistory struct { + Displayname string `json:"displayname"` + Id string `json:"id"` + JobID string `json:"jobid"` + Jobstatus int `json:"jobstatus"` + Name string `json:"name"` + Stats []string `json:"stats"` +} diff --git a/cloudstack/VirtualMachineService_mock.go b/cloudstack/VirtualMachineService_mock.go index 3de3537..bc1c8ae 100644 --- a/cloudstack/VirtualMachineService_mock.go +++ b/cloudstack/VirtualMachineService_mock.go @@ -298,6 +298,69 @@ func (mr *MockVirtualMachineServiceIfaceMockRecorder) GetVirtualMachinesMetricID return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "GetVirtualMachinesMetricID", reflect.TypeOf((*MockVirtualMachineServiceIface)(nil).GetVirtualMachinesMetricID), varargs...) } +// GetVirtualMachinesUsageHistoryByID mocks base method. +func (m *MockVirtualMachineServiceIface) GetVirtualMachinesUsageHistoryByID(id string, opts ...OptionFunc) (*VirtualMachinesUsageHistory, int, error) { + m.ctrl.T.Helper() + varargs := []interface{}{id} + for _, a := range opts { + varargs = append(varargs, a) + } + ret := m.ctrl.Call(m, "GetVirtualMachinesUsageHistoryByID", varargs...) + ret0, _ := ret[0].(*VirtualMachinesUsageHistory) + ret1, _ := ret[1].(int) + ret2, _ := ret[2].(error) + return ret0, ret1, ret2 +} + +// GetVirtualMachinesUsageHistoryByID indicates an expected call of GetVirtualMachinesUsageHistoryByID. +func (mr *MockVirtualMachineServiceIfaceMockRecorder) GetVirtualMachinesUsageHistoryByID(id interface{}, opts ...interface{}) *gomock.Call { + mr.mock.ctrl.T.Helper() + varargs := append([]interface{}{id}, opts...) + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "GetVirtualMachinesUsageHistoryByID", reflect.TypeOf((*MockVirtualMachineServiceIface)(nil).GetVirtualMachinesUsageHistoryByID), varargs...) +} + +// GetVirtualMachinesUsageHistoryByName mocks base method. +func (m *MockVirtualMachineServiceIface) GetVirtualMachinesUsageHistoryByName(name string, opts ...OptionFunc) (*VirtualMachinesUsageHistory, int, error) { + m.ctrl.T.Helper() + varargs := []interface{}{name} + for _, a := range opts { + varargs = append(varargs, a) + } + ret := m.ctrl.Call(m, "GetVirtualMachinesUsageHistoryByName", varargs...) + ret0, _ := ret[0].(*VirtualMachinesUsageHistory) + ret1, _ := ret[1].(int) + ret2, _ := ret[2].(error) + return ret0, ret1, ret2 +} + +// GetVirtualMachinesUsageHistoryByName indicates an expected call of GetVirtualMachinesUsageHistoryByName. +func (mr *MockVirtualMachineServiceIfaceMockRecorder) GetVirtualMachinesUsageHistoryByName(name interface{}, opts ...interface{}) *gomock.Call { + mr.mock.ctrl.T.Helper() + varargs := append([]interface{}{name}, opts...) + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "GetVirtualMachinesUsageHistoryByName", reflect.TypeOf((*MockVirtualMachineServiceIface)(nil).GetVirtualMachinesUsageHistoryByName), varargs...) +} + +// GetVirtualMachinesUsageHistoryID mocks base method. +func (m *MockVirtualMachineServiceIface) GetVirtualMachinesUsageHistoryID(name string, opts ...OptionFunc) (string, int, error) { + m.ctrl.T.Helper() + varargs := []interface{}{name} + for _, a := range opts { + varargs = append(varargs, a) + } + ret := m.ctrl.Call(m, "GetVirtualMachinesUsageHistoryID", varargs...) + ret0, _ := ret[0].(string) + ret1, _ := ret[1].(int) + ret2, _ := ret[2].(error) + return ret0, ret1, ret2 +} + +// GetVirtualMachinesUsageHistoryID indicates an expected call of GetVirtualMachinesUsageHistoryID. +func (mr *MockVirtualMachineServiceIfaceMockRecorder) GetVirtualMachinesUsageHistoryID(name interface{}, opts ...interface{}) *gomock.Call { + mr.mock.ctrl.T.Helper() + varargs := append([]interface{}{name}, opts...) + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "GetVirtualMachinesUsageHistoryID", reflect.TypeOf((*MockVirtualMachineServiceIface)(nil).GetVirtualMachinesUsageHistoryID), varargs...) +} + // ListVirtualMachines mocks base method. func (m *MockVirtualMachineServiceIface) ListVirtualMachines(p *ListVirtualMachinesParams) (*ListVirtualMachinesResponse, error) { m.ctrl.T.Helper() @@ -328,6 +391,21 @@ func (mr *MockVirtualMachineServiceIfaceMockRecorder) ListVirtualMachinesMetrics return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "ListVirtualMachinesMetrics", reflect.TypeOf((*MockVirtualMachineServiceIface)(nil).ListVirtualMachinesMetrics), p) } +// ListVirtualMachinesUsageHistory mocks base method. +func (m *MockVirtualMachineServiceIface) ListVirtualMachinesUsageHistory(p *ListVirtualMachinesUsageHistoryParams) (*ListVirtualMachinesUsageHistoryResponse, error) { + m.ctrl.T.Helper() + ret := m.ctrl.Call(m, "ListVirtualMachinesUsageHistory", p) + ret0, _ := ret[0].(*ListVirtualMachinesUsageHistoryResponse) + ret1, _ := ret[1].(error) + return ret0, ret1 +} + +// ListVirtualMachinesUsageHistory indicates an expected call of ListVirtualMachinesUsageHistory. +func (mr *MockVirtualMachineServiceIfaceMockRecorder) ListVirtualMachinesUsageHistory(p interface{}) *gomock.Call { + mr.mock.ctrl.T.Helper() + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "ListVirtualMachinesUsageHistory", reflect.TypeOf((*MockVirtualMachineServiceIface)(nil).ListVirtualMachinesUsageHistory), p) +} + // MigrateVirtualMachine mocks base method. func (m *MockVirtualMachineServiceIface) MigrateVirtualMachine(p *MigrateVirtualMachineParams) (*MigrateVirtualMachineResponse, error) { m.ctrl.T.Helper() @@ -498,6 +576,20 @@ func (mr *MockVirtualMachineServiceIfaceMockRecorder) NewListVirtualMachinesPara return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "NewListVirtualMachinesParams", reflect.TypeOf((*MockVirtualMachineServiceIface)(nil).NewListVirtualMachinesParams)) } +// NewListVirtualMachinesUsageHistoryParams mocks base method. +func (m *MockVirtualMachineServiceIface) NewListVirtualMachinesUsageHistoryParams() *ListVirtualMachinesUsageHistoryParams { + m.ctrl.T.Helper() + ret := m.ctrl.Call(m, "NewListVirtualMachinesUsageHistoryParams") + ret0, _ := ret[0].(*ListVirtualMachinesUsageHistoryParams) + return ret0 +} + +// NewListVirtualMachinesUsageHistoryParams indicates an expected call of NewListVirtualMachinesUsageHistoryParams. +func (mr *MockVirtualMachineServiceIfaceMockRecorder) NewListVirtualMachinesUsageHistoryParams() *gomock.Call { + mr.mock.ctrl.T.Helper() + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "NewListVirtualMachinesUsageHistoryParams", reflect.TypeOf((*MockVirtualMachineServiceIface)(nil).NewListVirtualMachinesUsageHistoryParams)) +} + // NewMigrateVirtualMachineParams mocks base method. func (m *MockVirtualMachineServiceIface) NewMigrateVirtualMachineParams(virtualmachineid string) *MigrateVirtualMachineParams { m.ctrl.T.Helper() diff --git a/cloudstack/VolumeService.go b/cloudstack/VolumeService.go index 081086b..727a4c1 100644 --- a/cloudstack/VolumeService.go +++ b/cloudstack/VolumeService.go @@ -68,6 +68,8 @@ type VolumeServiceIface interface { NewUpdateVolumeParams() *UpdateVolumeParams UploadVolume(p *UploadVolumeParams) (*UploadVolumeResponse, error) NewUploadVolumeParams(format string, name string, url string, zoneid string) *UploadVolumeParams + ChangeOfferingForVolume(p *ChangeOfferingForVolumeParams) (*ChangeOfferingForVolumeResponse, error) + NewChangeOfferingForVolumeParams(diskofferingid string, id string) *ChangeOfferingForVolumeParams } type AttachVolumeParams struct { @@ -205,6 +207,7 @@ type AttachVolumeResponse struct { Displayvolume bool `json:"displayvolume"` Domain string `json:"domain"` Domainid string `json:"domainid"` + Externaluuid string `json:"externaluuid"` Hasannotations bool `json:"hasannotations"` Hypervisor string `json:"hypervisor"` Id string `json:"id"` @@ -567,6 +570,7 @@ type CreateVolumeResponse struct { Displayvolume bool `json:"displayvolume"` Domain string `json:"domain"` Domainid string `json:"domainid"` + Externaluuid string `json:"externaluuid"` Hasannotations bool `json:"hasannotations"` Hypervisor string `json:"hypervisor"` Id string `json:"id"` @@ -817,6 +821,7 @@ type DestroyVolumeResponse struct { Displayvolume bool `json:"displayvolume"` Domain string `json:"domain"` Domainid string `json:"domainid"` + Externaluuid string `json:"externaluuid"` Hasannotations bool `json:"hasannotations"` Hypervisor string `json:"hypervisor"` Id string `json:"id"` @@ -996,6 +1001,7 @@ type DetachVolumeResponse struct { Displayvolume bool `json:"displayvolume"` Domain string `json:"domain"` Domainid string `json:"domainid"` + Externaluuid string `json:"externaluuid"` Hasannotations bool `json:"hasannotations"` Hypervisor string `json:"hypervisor"` Id string `json:"id"` @@ -2136,6 +2142,7 @@ type Volume struct { Displayvolume bool `json:"displayvolume"` Domain string `json:"domain"` Domainid string `json:"domainid"` + Externaluuid string `json:"externaluuid"` Hasannotations bool `json:"hasannotations"` Hypervisor string `json:"hypervisor"` Id string `json:"id"` @@ -2735,6 +2742,7 @@ type VolumesMetric struct { Displayvolume bool `json:"displayvolume"` Domain string `json:"domain"` Domainid string `json:"domainid"` + Externaluuid string `json:"externaluuid"` Hasannotations bool `json:"hasannotations"` Hypervisor string `json:"hypervisor"` Id string `json:"id"` @@ -2935,6 +2943,7 @@ type MigrateVolumeResponse struct { Displayvolume bool `json:"displayvolume"` Domain string `json:"domain"` Domainid string `json:"domainid"` + Externaluuid string `json:"externaluuid"` Hasannotations bool `json:"hasannotations"` Hypervisor string `json:"hypervisor"` Id string `json:"id"` @@ -3058,6 +3067,7 @@ type RecoverVolumeResponse struct { Displayvolume bool `json:"displayvolume"` Domain string `json:"domain"` Domainid string `json:"domainid"` + Externaluuid string `json:"externaluuid"` Hasannotations bool `json:"hasannotations"` Hypervisor string `json:"hypervisor"` Id string `json:"id"` @@ -3295,6 +3305,7 @@ type ResizeVolumeResponse struct { Displayvolume bool `json:"displayvolume"` Domain string `json:"domain"` Domainid string `json:"domainid"` + Externaluuid string `json:"externaluuid"` Hasannotations bool `json:"hasannotations"` Hypervisor string `json:"hypervisor"` Id string `json:"id"` @@ -3564,6 +3575,7 @@ type UpdateVolumeResponse struct { Displayvolume bool `json:"displayvolume"` Domain string `json:"domain"` Domainid string `json:"domainid"` + Externaluuid string `json:"externaluuid"` Hasannotations bool `json:"hasannotations"` Hypervisor string `json:"hypervisor"` Id string `json:"id"` @@ -3872,6 +3884,265 @@ type UploadVolumeResponse struct { Displayvolume bool `json:"displayvolume"` Domain string `json:"domain"` Domainid string `json:"domainid"` + Externaluuid string `json:"externaluuid"` + Hasannotations bool `json:"hasannotations"` + Hypervisor string `json:"hypervisor"` + Id string `json:"id"` + Isextractable bool `json:"isextractable"` + Isodisplaytext string `json:"isodisplaytext"` + Isoid string `json:"isoid"` + Isoname string `json:"isoname"` + JobID string `json:"jobid"` + Jobstatus int `json:"jobstatus"` + Maxiops int64 `json:"maxiops"` + Miniops int64 `json:"miniops"` + Name string `json:"name"` + Path string `json:"path"` + Physicalsize int64 `json:"physicalsize"` + Podid string `json:"podid"` + Podname string `json:"podname"` + Project string `json:"project"` + Projectid string `json:"projectid"` + Provisioningtype string `json:"provisioningtype"` + Quiescevm bool `json:"quiescevm"` + Serviceofferingdisplaytext string `json:"serviceofferingdisplaytext"` + Serviceofferingid string `json:"serviceofferingid"` + Serviceofferingname string `json:"serviceofferingname"` + Size int64 `json:"size"` + Snapshotid string `json:"snapshotid"` + State string `json:"state"` + Status string `json:"status"` + Storage string `json:"storage"` + Storageid string `json:"storageid"` + Storagetype string `json:"storagetype"` + Supportsstoragesnapshot bool `json:"supportsstoragesnapshot"` + Tags []Tags `json:"tags"` + Templatedisplaytext string `json:"templatedisplaytext"` + Templateid string `json:"templateid"` + Templatename string `json:"templatename"` + Type string `json:"type"` + Utilization string `json:"utilization"` + Virtualmachineid string `json:"virtualmachineid"` + Virtualsize int64 `json:"virtualsize"` + Vmdisplayname string `json:"vmdisplayname"` + Vmname string `json:"vmname"` + Vmstate string `json:"vmstate"` + Zoneid string `json:"zoneid"` + Zonename string `json:"zonename"` +} + +type ChangeOfferingForVolumeParams struct { + p map[string]interface{} +} + +func (p *ChangeOfferingForVolumeParams) toURLValues() url.Values { + u := url.Values{} + if p.p == nil { + return u + } + if v, found := p.p["automigrate"]; found { + vv := strconv.FormatBool(v.(bool)) + u.Set("automigrate", vv) + } + if v, found := p.p["diskofferingid"]; found { + u.Set("diskofferingid", v.(string)) + } + if v, found := p.p["id"]; found { + u.Set("id", v.(string)) + } + if v, found := p.p["maxiops"]; found { + vv := strconv.FormatInt(v.(int64), 10) + u.Set("maxiops", vv) + } + if v, found := p.p["miniops"]; found { + vv := strconv.FormatInt(v.(int64), 10) + u.Set("miniops", vv) + } + if v, found := p.p["shrinkok"]; found { + vv := strconv.FormatBool(v.(bool)) + u.Set("shrinkok", vv) + } + if v, found := p.p["size"]; found { + vv := strconv.FormatInt(v.(int64), 10) + u.Set("size", vv) + } + return u +} + +func (p *ChangeOfferingForVolumeParams) SetAutomigrate(v bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["automigrate"] = v +} + +func (p *ChangeOfferingForVolumeParams) GetAutomigrate() (bool, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["automigrate"].(bool) + return value, ok +} + +func (p *ChangeOfferingForVolumeParams) SetDiskofferingid(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["diskofferingid"] = v +} + +func (p *ChangeOfferingForVolumeParams) GetDiskofferingid() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["diskofferingid"].(string) + return value, ok +} + +func (p *ChangeOfferingForVolumeParams) SetId(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["id"] = v +} + +func (p *ChangeOfferingForVolumeParams) GetId() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["id"].(string) + return value, ok +} + +func (p *ChangeOfferingForVolumeParams) SetMaxiops(v int64) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["maxiops"] = v +} + +func (p *ChangeOfferingForVolumeParams) GetMaxiops() (int64, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["maxiops"].(int64) + return value, ok +} + +func (p *ChangeOfferingForVolumeParams) SetMiniops(v int64) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["miniops"] = v +} + +func (p *ChangeOfferingForVolumeParams) GetMiniops() (int64, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["miniops"].(int64) + return value, ok +} + +func (p *ChangeOfferingForVolumeParams) SetShrinkok(v bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["shrinkok"] = v +} + +func (p *ChangeOfferingForVolumeParams) GetShrinkok() (bool, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["shrinkok"].(bool) + return value, ok +} + +func (p *ChangeOfferingForVolumeParams) SetSize(v int64) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["size"] = v +} + +func (p *ChangeOfferingForVolumeParams) GetSize() (int64, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["size"].(int64) + return value, ok +} + +// You should always use this function to get a new ChangeOfferingForVolumeParams instance, +// as then you are sure you have configured all required params +func (s *VolumeService) NewChangeOfferingForVolumeParams(diskofferingid string, id string) *ChangeOfferingForVolumeParams { + p := &ChangeOfferingForVolumeParams{} + p.p = make(map[string]interface{}) + p.p["diskofferingid"] = diskofferingid + p.p["id"] = id + return p +} + +// Change disk offering of the volume and also an option to auto migrate if required to apply the new disk offering +func (s *VolumeService) ChangeOfferingForVolume(p *ChangeOfferingForVolumeParams) (*ChangeOfferingForVolumeResponse, error) { + resp, err := s.cs.newRequest("changeOfferingForVolume", p.toURLValues()) + if err != nil { + return nil, err + } + + var r ChangeOfferingForVolumeResponse + if err := json.Unmarshal(resp, &r); err != nil { + return nil, err + } + + // If we have a async client, we need to wait for the async result + if s.cs.async { + b, err := s.cs.GetAsyncJobResult(r.JobID, s.cs.timeout) + if err != nil { + if err == AsyncTimeoutErr { + return &r, err + } + return nil, err + } + + b, err = getRawValue(b) + if err != nil { + return nil, err + } + + if err := json.Unmarshal(b, &r); err != nil { + return nil, err + } + } + + return &r, nil +} + +type ChangeOfferingForVolumeResponse struct { + Account string `json:"account"` + Attached string `json:"attached"` + Chaininfo string `json:"chaininfo"` + Clusterid string `json:"clusterid"` + Clustername string `json:"clustername"` + Created string `json:"created"` + Destroyed bool `json:"destroyed"` + Deviceid int64 `json:"deviceid"` + DiskBytesReadRate int64 `json:"diskBytesReadRate"` + DiskBytesWriteRate int64 `json:"diskBytesWriteRate"` + DiskIopsReadRate int64 `json:"diskIopsReadRate"` + DiskIopsWriteRate int64 `json:"diskIopsWriteRate"` + Diskioread int64 `json:"diskioread"` + Diskiowrite int64 `json:"diskiowrite"` + Diskkbsread int64 `json:"diskkbsread"` + Diskkbswrite int64 `json:"diskkbswrite"` + Diskofferingdisplaytext string `json:"diskofferingdisplaytext"` + Diskofferingid string `json:"diskofferingid"` + Diskofferingname string `json:"diskofferingname"` + Displayvolume bool `json:"displayvolume"` + Domain string `json:"domain"` + Domainid string `json:"domainid"` + Externaluuid string `json:"externaluuid"` Hasannotations bool `json:"hasannotations"` Hypervisor string `json:"hypervisor"` Id string `json:"id"` diff --git a/cloudstack/VolumeService_mock.go b/cloudstack/VolumeService_mock.go index 3e12e0d..1984c0a 100644 --- a/cloudstack/VolumeService_mock.go +++ b/cloudstack/VolumeService_mock.go @@ -67,6 +67,21 @@ func (mr *MockVolumeServiceIfaceMockRecorder) AttachVolume(p interface{}) *gomoc return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "AttachVolume", reflect.TypeOf((*MockVolumeServiceIface)(nil).AttachVolume), p) } +// ChangeOfferingForVolume mocks base method. +func (m *MockVolumeServiceIface) ChangeOfferingForVolume(p *ChangeOfferingForVolumeParams) (*ChangeOfferingForVolumeResponse, error) { + m.ctrl.T.Helper() + ret := m.ctrl.Call(m, "ChangeOfferingForVolume", p) + ret0, _ := ret[0].(*ChangeOfferingForVolumeResponse) + ret1, _ := ret[1].(error) + return ret0, ret1 +} + +// ChangeOfferingForVolume indicates an expected call of ChangeOfferingForVolume. +func (mr *MockVolumeServiceIfaceMockRecorder) ChangeOfferingForVolume(p interface{}) *gomock.Call { + mr.mock.ctrl.T.Helper() + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "ChangeOfferingForVolume", reflect.TypeOf((*MockVolumeServiceIface)(nil).ChangeOfferingForVolume), p) +} + // CreateVolume mocks base method. func (m *MockVolumeServiceIface) CreateVolume(p *CreateVolumeParams) (*CreateVolumeResponse, error) { m.ctrl.T.Helper() @@ -387,6 +402,20 @@ func (mr *MockVolumeServiceIfaceMockRecorder) NewAttachVolumeParams(id, virtualm return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "NewAttachVolumeParams", reflect.TypeOf((*MockVolumeServiceIface)(nil).NewAttachVolumeParams), id, virtualmachineid) } +// NewChangeOfferingForVolumeParams mocks base method. +func (m *MockVolumeServiceIface) NewChangeOfferingForVolumeParams(diskofferingid, id string) *ChangeOfferingForVolumeParams { + m.ctrl.T.Helper() + ret := m.ctrl.Call(m, "NewChangeOfferingForVolumeParams", diskofferingid, id) + ret0, _ := ret[0].(*ChangeOfferingForVolumeParams) + return ret0 +} + +// NewChangeOfferingForVolumeParams indicates an expected call of NewChangeOfferingForVolumeParams. +func (mr *MockVolumeServiceIfaceMockRecorder) NewChangeOfferingForVolumeParams(diskofferingid, id interface{}) *gomock.Call { + mr.mock.ctrl.T.Helper() + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "NewChangeOfferingForVolumeParams", reflect.TypeOf((*MockVolumeServiceIface)(nil).NewChangeOfferingForVolumeParams), diskofferingid, id) +} + // NewCreateVolumeParams mocks base method. func (m *MockVolumeServiceIface) NewCreateVolumeParams() *CreateVolumeParams { m.ctrl.T.Helper() diff --git a/cloudstack/cloudstack.go b/cloudstack/cloudstack.go index 0dcc574..31b1078 100644 --- a/cloudstack/cloudstack.go +++ b/cloudstack/cloudstack.go @@ -125,6 +125,7 @@ type CloudStackClient struct { Hypervisor HypervisorServiceIface ISO ISOServiceIface ImageStore ImageStoreServiceIface + InfrastructureUsage InfrastructureUsageServiceIface InternalLB InternalLBServiceIface Kubernetes KubernetesServiceIface LDAP LDAPServiceIface @@ -230,6 +231,7 @@ func newClient(apiurl string, apikey string, secret string, async bool, verifyss cs.Hypervisor = NewHypervisorService(cs) cs.ISO = NewISOService(cs) cs.ImageStore = NewImageStoreService(cs) + cs.InfrastructureUsage = NewInfrastructureUsageService(cs) cs.InternalLB = NewInternalLBService(cs) cs.Kubernetes = NewKubernetesService(cs) cs.LDAP = NewLDAPService(cs) @@ -308,6 +310,7 @@ func newMockClient(ctrl *gomock.Controller) *CloudStackClient { cs.Hypervisor = NewMockHypervisorServiceIface(ctrl) cs.ISO = NewMockISOServiceIface(ctrl) cs.ImageStore = NewMockImageStoreServiceIface(ctrl) + cs.InfrastructureUsage = NewMockInfrastructureUsageServiceIface(ctrl) cs.InternalLB = NewMockInternalLBServiceIface(ctrl) cs.Kubernetes = NewMockKubernetesServiceIface(ctrl) cs.LDAP = NewMockLDAPServiceIface(ctrl) @@ -944,6 +947,14 @@ func NewImageStoreService(cs *CloudStackClient) ImageStoreServiceIface { return &ImageStoreService{cs: cs} } +type InfrastructureUsageService struct { + cs *CloudStackClient +} + +func NewInfrastructureUsageService(cs *CloudStackClient) InfrastructureUsageServiceIface { + return &InfrastructureUsageService{cs: cs} +} + type InternalLBService struct { cs *CloudStackClient } diff --git a/generate/layout.go b/generate/layout.go index 197de1c..c206452 100644 --- a/generate/layout.go +++ b/generate/layout.go @@ -85,6 +85,13 @@ var layout = apiInfo{ "updateNetworkServiceProvider", "updatePhysicalNetwork", "updateStorageNetworkIpRange", + "deleteGuestNetworkIpv6Prefix", + "createGuestNetworkIpv6Prefix", + "listGuestNetworkIpv6Prefixes", + "createNetworkPermissions", + "resetNetworkPermissions", + "listNetworkPermissions", + "removeNetworkPermissions", }, "VirtualMachineService": { "addNicToVirtualMachine", @@ -109,6 +116,7 @@ var layout = apiInfo{ "stopVirtualMachine", "updateDefaultNicForVirtualMachine", "updateVirtualMachine", + "listVirtualMachinesUsageHistory", }, "VPNService": { "addVpnUser", @@ -149,6 +157,10 @@ var layout = apiInfo{ "updateEgressFirewallRule", "updateFirewallRule", "updatePortForwardingRule", + "listIpv6FirewallRules", + "createIpv6FirewallRule", + "updateIpv6FirewallRule", + "deleteIpv6FirewallRule", }, "AutoScaleService": { "createAutoScalePolicy", @@ -214,6 +226,7 @@ var layout = apiInfo{ "resizeVolume", "updateVolume", "uploadVolume", + "changeOfferingForVolume", }, "VPCService": { "createPrivateGateway", @@ -245,6 +258,8 @@ var layout = apiInfo{ "updateTemplate", "updateTemplatePermissions", "upgradeRouterTemplate", + "listTemplateDirectDownloadCertificates", + "provisionTemplateDirectDownloadCertificate", }, "AccountService": { "createAccount", @@ -285,6 +300,7 @@ var layout = apiInfo{ "listUsageTypes", "removeRawUsageRecords", "updateTrafficType", + "listUsageServerMetrics", }, "SnapshotService": { "createSnapshot", @@ -431,6 +447,7 @@ var layout = apiInfo{ "scaleSystemVm", "startSystemVm", "stopSystemVm", + "patchSystemVm", }, "RoleService": { "createRole", @@ -485,6 +502,7 @@ var layout = apiInfo{ "listDedicatedGuestVlanRanges", "listVlanIpRanges", "releaseDedicatedGuestVlanRange", + "listGuestVlans", }, "UCSService": { "addUcsManager", @@ -615,6 +633,7 @@ var layout = apiInfo{ "disassociateIpAddress", "listPublicIpAddresses", "updateIpAddress", + "releaseIpAddress", }, "StoragePoolService": { "cancelStorageMaintenance", @@ -699,4 +718,8 @@ var layout = apiInfo{ "updateKubernetesSupportedVersion", "upgradeKubernetesCluster", }, + "InfrastructureUsageService": { + "listManagementServersMetrics", + "listDbMetrics", + }, } diff --git a/generate/listApis.json b/generate/listApis.json index d8b16b6..c50262c 100644 --- a/generate/listApis.json +++ b/generate/listApis.json @@ -22,32 +22,32 @@ ], "related": "", "response": [ + { + "description": "resource type", + "name": "resourcetype", + "type": "resourceobjecttype" + }, {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "id of the resource", + "name": "resourceid", + "type": "string" }, { "description": "base64 representation of resource icon", "name": "base64image", "type": "string" }, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, + {}, { - "description": "resource type", - "name": "resourcetype", - "type": "resourceobjecttype" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ], "since": "4.16.0.0" @@ -67,42 +67,42 @@ "type": "list" }, { - "description": "the ID of the containing domain(s), null for public offerings", + "description": "the display text of the vpc offering", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", - "required": false, - "type": "list" + "name": "displaytext", + "required": true, + "type": "string" }, { - "description": "the ID of the service offering for the VPC router appliance", + "description": "the name of the vpc offering", "length": 255, - "name": "serviceofferingid", - "related": "createServiceOffering,updateServiceOffering,listServiceOfferings", - "required": false, - "type": "uuid" + "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", + "description": "desired service capabilities as part of vpc offering", "length": 255, - "name": "serviceproviderlist", + "name": "servicecapabilitylist", "required": false, + "since": "4.4", "type": "map" }, { - "description": "services supported by the vpc offering", + "description": "the ID of the containing domain(s), null for public offerings", "length": 255, - "name": "supportedservices", - "required": true, + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", + "required": false, "type": "list" }, { - "description": "desired service capabilities as part of vpc offering", + "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": "servicecapabilitylist", + "name": "internetprotocol", "required": false, - "since": "4.4", - "type": "map" + "since": "4.17.0", + "type": "string" }, { "description": "set to true if the offering is to be enabled during creation. Default is false", @@ -113,22 +113,51 @@ "type": "boolean" }, { - "description": "the name of the vpc offering", + "description": "the ID of the service offering for the VPC router appliance", "length": 255, - "name": "name", - "required": true, - "type": "string" + "name": "serviceofferingid", + "related": "createServiceOffering,updateServiceOffering,listServiceOfferings", + "required": false, + "type": "uuid" }, { - "description": "the display text of the vpc offering", + "description": "services supported by the vpc offering", "length": 255, - "name": "displaytext", + "name": "supportedservices", "required": true, - "type": "string" + "type": "list" + }, + { + "description": "provider to service mapping. If not specified, the provider for the service will be mapped to the default provider on the physical network", + "length": 255, + "name": "serviceproviderlist", + "required": false, + "type": "map" } ], "related": "updateVPCOffering,listVPCOfferings", "response": [ + { + "description": "true if vpc offering is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": " indicated if the offering can support region level vpc", + "name": "supportsregionLevelvpc", + "type": "boolean" + }, + { + "description": "the internet protocol of the vpc offering", + "name": "internetprotocol", + "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": "an alternate display text of the vpc offering.", "name": "displaytext", @@ -140,63 +169,52 @@ "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "state of the vpc offering. Can be Disabled/Enabled", + "name": "state", "type": "string" }, { - "description": "the date this vpc offering was created", - "name": "created", - "type": "date" + "description": "the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "zone", + "type": "string" }, { - "description": "the name of the vpc offering", - "name": "name", + "description": "the id of the vpc offering", + "name": "id", "type": "string" }, {}, - {}, { "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", "name": "zoneid", "type": "string" }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "state of the vpc offering. Can be Disabled/Enabled", - "name": "state", - "type": "string" - }, { "description": "the list of supported services", "name": "service", "response": [ - { - "description": "the service name", - "name": "name", - "type": "string" - }, { "description": "the service provider name", "name": "provider", "response": [ + { + "description": "services for this provider", + "name": "servicelist", + "type": "list" + }, { "description": "true if individual services can be enabled/disabled", "name": "canenableindividualservice", "type": "boolean" }, { - "description": "the destination physical network", - "name": "destinationphysicalnetworkid", + "description": "state of the network provider", + "name": "state", "type": "string" }, { - "description": "state of the network provider", - "name": "state", + "description": "the provider name", + "name": "name", "type": "string" }, { @@ -210,27 +228,22 @@ "type": "string" }, { - "description": "services for this provider", - "name": "servicelist", - "type": "list" - }, - { - "description": "the provider name", - "name": "name", + "description": "the destination physical network", + "name": "destinationphysicalnetworkid", "type": "string" } ], "type": "list" }, + { + "description": "the service name", + "name": "name", + "type": "string" + }, { "description": "the list of capabilities", "name": "capability", "response": [ - { - "description": "the capability value", - "name": "value", - "type": "string" - }, { "description": "can this service capability value can be choosable while creatine network offerings", "name": "canchooseservicecapability", @@ -240,6 +253,11 @@ "description": "the capability name", "name": "name", "type": "string" + }, + { + "description": "the capability value", + "name": "value", + "type": "string" } ], "type": "list" @@ -248,33 +266,28 @@ "type": "list" }, { - "description": "true if vpc offering is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": " indicates if the vpc offering supports distributed router for one-hop forwarding", - "name": "distributedvpcrouter", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the id of the vpc offering", - "name": "id", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "domainid", - "type": "string" + "description": "the date this vpc offering was created", + "name": "created", + "type": "date" }, { - "description": "the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zone", + "description": "the name of the vpc offering", + "name": "name", "type": "string" }, { - "description": " indicated if the offering can support region level vpc", - "name": "supportsregionLevelvpc", + "description": " indicates if the vpc offering supports distributed router for one-hop forwarding", + "name": "distributedvpcrouter", "type": "boolean" } ] @@ -285,31 +298,31 @@ "name": "createPod", "params": [ { - "description": "the gateway for the Pod", + "description": "the starting IP address for the Pod", "length": 255, - "name": "gateway", + "name": "startip", "required": true, "type": "string" }, { - "description": "the ending IP address for the Pod", + "description": "the gateway for the Pod", "length": 255, - "name": "endip", - "required": false, + "name": "gateway", + "required": true, "type": "string" }, { - "description": "the starting IP address for the Pod", + "description": "the name of the Pod", "length": 255, - "name": "startip", + "name": "name", "required": true, "type": "string" }, { - "description": "the netmask for the Pod", + "description": "the ending IP address for the Pod", "length": 255, - "name": "netmask", - "required": true, + "name": "endip", + "required": false, "type": "string" }, { @@ -319,13 +332,6 @@ "required": false, "type": "string" }, - { - "description": "the name of the Pod", - "length": 255, - "name": "name", - "required": true, - "type": "string" - }, { "description": "the Zone ID in which the Pod will be created", "length": 255, @@ -333,80 +339,40 @@ "related": "createZone,updateZone,listZones,listZones", "required": true, "type": "uuid" - } - ], - "related": "listPods,updatePod,createManagementNetworkIpRange", - "response": [ - {}, - { - "description": "the IP ranges for the Pod", - "name": "ipranges", - "response": [ - { - "description": "the ending IP for the range", - "name": "endip", - "type": "string" - }, - { - "description": "indicates if range is dedicated for CPVM and SSVM", - "name": "forsystemvms", - "type": "string" - }, - { - "description": "indicates Vlan ID for the range", - "name": "vlanid", - "type": "string" - }, - { - "description": "the starting IP for the range", - "name": "startip", - "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 netmask of the Pod", + "description": "the netmask for the Pod", + "length": 255, "name": "netmask", + "required": true, "type": "string" - }, + } + ], + "related": "listPods,updatePod,createManagementNetworkIpRange", + "response": [ { "description": "true if the entity/resource has annotations", "name": "hasannotations", "type": "boolean" }, + {}, { - "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 UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the name of the Pod", + "name": "name", "type": "string" }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "the capacity of the Pod", "name": "capacity", "response": [ { - "description": "the Pod ID", - "name": "podid", - "type": "string" - }, - { - "description": "the Cluster name", - "name": "clustername", + "description": "the Cluster ID", + "name": "clusterid", "type": "string" }, { @@ -415,23 +381,33 @@ "type": "long" }, { - "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", + "description": "the Pod ID", + "name": "podid", "type": "string" }, { - "description": "the capacity name", - "name": "name", + "description": "the Pod name", + "name": "podname", "type": "string" }, { - "description": "the Cluster ID", - "name": "clusterid", + "description": "the Cluster name", + "name": "clustername", + "type": "string" + }, + { + "description": "the Zone ID", + "name": "zoneid", + "type": "string" + }, + { + "description": "the capacity name", + "name": "name", "type": "string" }, { @@ -445,64 +421,111 @@ "type": "string" }, { - "description": "the Pod name", - "name": "podname", - "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", + "description": "the percentage of capacity currently in use", + "name": "percentused", "type": "string" } ], "type": "list" }, { - "description": "the starting IP for the Pod. This parameter is deprecated, please use 'startip' from ipranges parameter.", - "name": "startip", - "type": "list" + "description": "the Zone name of the Pod", + "name": "zonename", + "type": "string" }, { "description": "the allocation state of the Pod", "name": "allocationstate", "type": "string" }, + { + "description": "the ending IP for the Pod. This parameter is deprecated, please use 'endip' from ipranges parameter.", + "name": "endip", + "type": "list" + }, + { + "description": "indicates Vlan ID for the range. This parameter is deprecated, please use 'vlanid' from ipranges parameter.", + "name": "vlanid", + "type": "list" + }, { "description": "the gateway of the Pod", "name": "gateway", "type": "string" }, { - "description": "the Zone name of the Pod", - "name": "zonename", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the Zone ID of the Pod", - "name": "zoneid", - "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 Pod", "name": "id", "type": "string" }, + {}, { - "description": "the ending IP for the Pod. This parameter is deprecated, please use 'endip' from ipranges parameter.", - "name": "endip", - "type": "list" + "description": "the 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", + "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 CIDR for the range", + "name": "cidr", + "type": "string" + }, + { + "description": "the ending IP for the range", + "name": "endip", + "type": "string" + }, + { + "description": "indicates Vlan ID for the range", + "name": "vlanid", + "type": "string" + }, + { + "description": "the gateway for the range", + "name": "gateway", + "type": "string" + }, + { + "description": "the starting IP for the range", + "name": "startip", + "type": "string" + } + ], "type": "list" }, - {} + { + "description": "the Zone ID of the Pod", + "name": "zoneid", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } ] }, { @@ -511,25 +534,26 @@ "name": "ldapCreateAccount", "params": [ { - "description": "Specifies a timezone for this command. For more information on the timezone parameter, see Time Zone Format.", + "description": "Network domain for the account's networks", "length": 255, - "name": "timezone", + "name": "networkdomain", "required": false, "type": "string" }, { - "description": "Network domain for the account's networks", + "description": "Specifies a timezone for this command. For more information on the timezone parameter, see Time Zone Format.", "length": 255, - "name": "networkdomain", + "name": "timezone", "required": false, "type": "string" }, { - "description": "Account UUID, required for adding account from external provisioning system", + "description": "Creates the user under the specified domain.", "length": 255, - "name": "accountid", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", "required": false, - "type": "string" + "type": "uuid" }, { "description": "Creates the account under the specified role.", @@ -540,31 +564,31 @@ "type": "uuid" }, { - "description": "details for account used to store specific parameters", + "description": "Account UUID, required for adding account from external provisioning system", "length": 255, - "name": "accountdetails", + "name": "accountid", "required": false, - "type": "map" + "type": "string" }, { - "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", + "description": "details for account used to store specific parameters", "length": 255, - "name": "accounttype", + "name": "accountdetails", "required": false, - "type": "short" + "type": "map" }, { - "description": "Unique username.", + "description": "User UUID, required for adding account from external provisioning system", "length": 255, - "name": "username", - "required": true, + "name": "userid", + "required": false, "type": "string" }, { @@ -575,148 +599,147 @@ "type": "string" }, { - "description": "Creates the user under the specified domain.", + "description": "Type of the account. Specify 0 for user, 1 for root admin, and 2 for domain admin", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", + "name": "accounttype", "required": false, - "type": "uuid" + "type": "integer" } ], "related": "createAccount,disableAccount,enableAccount,lockAccount,updateAccount,markDefaultZoneForAccount,listAccounts,listAccounts", "response": [ + { + "description": "the total secondary storage space (in GiB) available to be used for this account", + "name": "secondarystorageavailable", + "type": "string" + }, { "description": "path of the Domain the account belongs to", "name": "domainpath", "type": "string" }, + { + "description": "the total number of public ip addresses allocated for this account", + "name": "iptotal", + "type": "long" + }, { "description": "the total number of cpu cores available to be created for this account", "name": "cpuavailable", "type": "string" }, { - "description": "the total number of vpcs available to be created for this account", - "name": "vpcavailable", - "type": "string" + "description": "the total number of snapshots stored by this account", + "name": "snapshottotal", + "type": "long" }, { - "description": "the total memory (in MB) the account can own", - "name": "memorylimit", + "description": "id of the Domain the account belongs to", + "name": "domainid", "type": "string" }, + {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the total memory (in MB) owned by account", + "name": "memorytotal", + "type": "long" + }, + { + "description": "the total number of virtual machines running for this account", + "name": "vmrunning", "type": "integer" }, + {}, { - "description": "name of the Domain the account belongs to", - "name": "domain", + "description": "the total number of vpcs the account can own", + "name": "vpclimit", "type": "string" }, { - "description": "the total number of projects available for administration by this account", - "name": "projectavailable", + "description": "the network domain", + "name": "networkdomain", "type": "string" }, { - "description": "the total number of virtual machines available for this account to acquire", - "name": "vmavailable", + "description": "the total number of virtual machines that can be deployed by this account", + "name": "vmlimit", "type": "string" }, { - "description": "the total number of projects being administrated by this account", - "name": "projecttotal", + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", "type": "long" }, { - "description": "the name of the role", - "name": "rolename", - "type": "string" - }, - { - "description": "the date when this account was created", - "name": "created", - "type": "date" - }, - { - "description": "the total number of virtual machines that can be deployed by this account", - "name": "vmlimit", - "type": "string" - }, - { - "description": "the total number of templates which can be created by this account", - "name": "templatelimit", + "description": "the total secondary storage space (in GiB) the account can own", + "name": "secondarystoragelimit", "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", + "description": "the total number of projects being administrated by this account", + "name": "projecttotal", "type": "long" }, { - "description": "the total number of public ip addresses this account can acquire", - "name": "iplimit", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the total number of public ip addresses available for this account to acquire", - "name": "ipavailable", + "description": "name of the Domain the account belongs to", + "name": "domain", "type": "string" }, { - "description": "the total number of virtual machines deployed by this account", - "name": "vmtotal", - "type": "long" - }, - { - "description": "the total number of cpu cores the account can own", - "name": "cpulimit", + "description": "the total number of projects available for administration by this account", + "name": "projectavailable", "type": "string" }, - {}, { - "description": "true if the account requires cleanup", - "name": "iscleanuprequired", + "description": "true if account is default, false otherwise", + "name": "isdefault", "type": "boolean" }, { - "description": "the total volume being used by this account", - "name": "volumetotal", + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", "type": "long" }, { - "description": "the id of the account", - "name": "id", - "type": "string" + "description": "the total number of vpcs owned by account", + "name": "vpctotal", + "type": "long" }, { - "description": "the total volume available for this account", - "name": "volumeavailable", + "description": "the total number of virtual machines available for this account to acquire", + "name": "vmavailable", "type": "string" }, { - "description": "the total number of snapshots which can be stored by this account", - "name": "snapshotlimit", + "description": "the total number of snapshots available for this account", + "name": "snapshotavailable", "type": "string" }, { - "description": "the total number of networks owned by account", - "name": "networktotal", - "type": "long" + "description": "details for the account", + "name": "accountdetails", + "type": "map" }, { - "description": "id of the Domain the account belongs to", - "name": "domainid", + "description": "the total number of public ip addresses this account can acquire", + "name": "iplimit", "type": "string" }, { - "description": "the ID of the role", - "name": "roleid", + "description": "the total number of templates which can be created by this account", + "name": "templatelimit", "type": "string" }, - {}, { "description": "the total volume which can be used by this account", "name": "volumelimit", @@ -728,78 +751,28 @@ "type": "list" }, { - "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": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "the default zone of the account", - "name": "defaultzoneid", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the total primary storage space (in GiB) owned by account", - "name": "primarystoragetotal", - "type": "long" - }, - { - "description": "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", + "description": "the total number of virtual machines stopped for this account", + "name": "vmstopped", "type": "integer" }, { - "description": "the total secondary storage space (in GiB) available to be used for this account", - "name": "secondarystorageavailable", + "description": "the total number of snapshots which can be stored by this account", + "name": "snapshotlimit", "type": "string" }, { - "description": "account type (admin, domain-admin, user)", - "name": "accounttype", - "type": "short" - }, - { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" - }, - { - "description": "the network domain", - "name": "networkdomain", + "description": "the total number of networks the account can own", + "name": "networklimit", "type": "string" }, { - "description": "true if account is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "the state of the account", - "name": "state", - "type": "string" + "description": "the total volume being used by this account", + "name": "volumetotal", + "type": "long" }, { - "description": "the total memory (in MB) available to be created for this account", - "name": "memoryavailable", + "description": "the total number of projects the account can own", + "name": "projectlimit", "type": "string" }, { @@ -808,57 +781,47 @@ "type": "long" }, { - "description": "the total secondary storage space (in GiB) the account can own", - "name": "secondarystoragelimit", - "type": "string" - }, - { - "description": "details for the account", - "name": "accountdetails", - "type": "map" + "description": "the total primary storage space (in GiB) owned by account", + "name": "primarystoragetotal", + "type": "long" }, { - "description": "the total number of vpcs the account can own", - "name": "vpclimit", + "description": "the total volume available for this account", + "name": "volumeavailable", "type": "string" }, { - "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": "the total number of public ip addresses allocated for this account", - "name": "iptotal", - "type": "long" - }, - { - "description": "the total number of snapshots stored by this account", - "name": "snapshottotal", - "type": "long" - }, { "description": "the list of users associated with account", "name": "user", "response": [ { - "description": "the user lastname", - "name": "lastname", + "description": "the api key of the user", + "name": "apikey", "type": "string" }, { - "description": "the secret key of the user", - "name": "secretkey", + "description": "true if user is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "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", + "description": "the account name of the user", + "name": "account", "type": "string" }, { - "description": "the timezone user was created in", - "name": "timezone", + "description": "the domain ID of the user", + "name": "domainid", "type": "string" }, { @@ -867,44 +830,49 @@ "type": "string" }, { - "description": "the user state", - "name": "state", + "description": "the user ID", + "name": "id", "type": "string" }, { - "description": "the account type of the user", - "name": "accounttype", - "type": "short" + "description": "the user firstname", + "name": "firstname", + "type": "string" }, { - "description": "the user ID", - "name": "id", + "description": "the secret key of the user", + "name": "secretkey", "type": "string" }, { - "description": "true if user is default, false otherwise", - "name": "isdefault", + "description": "the user state", + "name": "state", + "type": "string" + }, + { + "description": "the boolean value representing if the updating target is in caller's child domain", + "name": "iscallerchilddomain", "type": "boolean" }, { - "description": "the type of the role", - "name": "roletype", + "description": "the user lastname", + "name": "lastname", "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": "the domain ID of the user", - "name": "domainid", + "description": "the source type of the user in lowercase, such as native, ldap, saml2", + "name": "usersource", "type": "string" }, { - "description": "the boolean value representing if the updating target is in caller's child domain", - "name": "iscallerchilddomain", - "type": "boolean" + "description": "the timezone user was created in", + "name": "timezone", + "type": "string" }, { "description": "the user name", @@ -912,24 +880,24 @@ "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 name of the role", - "name": "rolename", + "description": "the type of the role", + "name": "roletype", "type": "string" }, { - "description": "the account name of the user", - "name": "account", + "description": "the name of the role", + "name": "rolename", "type": "string" }, { - "description": "the user firstname", - "name": "firstname", - "type": "string" + "description": "the account type of the user", + "name": "accounttype", + "type": "integer" }, { "description": "the user email address", @@ -940,69 +908,124 @@ "description": "the domain name of the user", "name": "domain", "type": "string" - }, - { - "description": "the date and time the user account was created", - "name": "created", - "type": "date" - }, - { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" } ], "type": "list" }, + { + "description": "the total memory (in MB) the account can own", + "name": "memorylimit", + "type": "string" + }, + { + "description": "true if the account requires cleanup", + "name": "iscleanuprequired", + "type": "boolean" + }, + { + "description": "the total number of cpu cores owned by account", + "name": "cputotal", + "type": "long" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the default zone of the account", + "name": "defaultzoneid", + "type": "string" + }, { "description": "the type of the role (Admin, ResourceAdmin, DomainAdmin, User)", "name": "roletype", "type": "string" }, { - "description": "the total number of projects the account can own", - "name": "projectlimit", + "description": "the total number of templates available to be created by this account", + "name": "templateavailable", "type": "string" }, { - "description": "the total number of virtual machines stopped for this account", - "name": "vmstopped", - "type": "integer" + "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 available for this account to acquire", + "name": "ipavailable", + "type": "string" }, { "description": "the total secondary storage space (in GiB) owned by account", "name": "secondarystoragetotal", "type": "float" }, + { + "description": "the total number of networks available to be created for this account", + "name": "networkavailable", + "type": "string" + }, { "description": "the name of the account", "name": "name", "type": "string" }, { - "description": "the total number of templates available to be created by this account", - "name": "templateavailable", + "description": "the name of the role", + "name": "rolename", "type": "string" }, { - "description": "the total number of vpcs owned by account", - "name": "vpctotal", + "description": "the date when this account was created", + "name": "created", + "type": "date" + }, + { + "description": "the id of the account", + "name": "id", + "type": "string" + }, + { + "description": "the total primary storage space (in GiB) the account can own", + "name": "primarystoragelimit", + "type": "string" + }, + { + "description": "the total number of virtual machines deployed by this account", + "name": "vmtotal", "type": "long" }, { - "description": "the total number of snapshots available for this account", - "name": "snapshotavailable", + "description": "the total number of cpu cores the account can own", + "name": "cpulimit", "type": "string" }, { - "description": "the total number of networks available to be created for this account", - "name": "networkavailable", + "description": "the total primary storage space (in GiB) available to be used for this account", + "name": "primarystorageavailable", "type": "string" }, { - "description": "the total number of cpu cores owned by account", - "name": "cputotal", + "description": "account type (admin, domain-admin, user)", + "name": "accounttype", + "type": "integer" + }, + { + "description": "the state of the account", + "name": "state", + "type": "string" + }, + { + "description": "the total number of networks owned by account", + "name": "networktotal", "type": "long" + }, + { + "description": "the total number of vpcs available to be created for this account", + "name": "vpcavailable", + "type": "string" } ], "since": "4.2.0" @@ -1026,22 +1049,22 @@ "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.6.0" @@ -1051,6 +1074,14 @@ "isasync": true, "name": "copyIso", "params": [ + { + "description": "Template ID.", + "length": 255, + "name": "id", + "related": "prepareTemplate,copyIso,listIsos,registerIso,updateIso,copyTemplate,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", + "required": true, + "type": "uuid" + }, { "description": "ID of the zone the template is being copied to.", "length": 255, @@ -1067,14 +1098,6 @@ "required": false, "type": "list" }, - { - "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", - "required": true, - "type": "uuid" - }, { "description": "ID of the zone the template is currently hosted on. If not specified and template is cross-zone, then we will sync this template to region wide image store.", "length": 255, @@ -1087,83 +1110,78 @@ "related": "prepareTemplate,listIsos,registerIso,updateIso,copyTemplate,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", "response": [ { - "description": "if Datadisk template, then id of the root disk template this template belongs to", - "name": "parenttemplateid", - "type": "string" - }, - { - "description": "the tag of this template", - "name": "templatetag", - "type": "string" + "description": "additional key/value details tied with template", + "name": "details", + "type": "map" }, { "description": "if root disk template, then ids of the datas disk templates this template owns", "name": "childtemplates", "type": "set" }, + { + "description": "the account name to which the template belongs", + "name": "account", + "type": "string" + }, { "description": "the size of the template", "name": "size", "type": "long" }, { - "description": "the type of the template", - "name": "templatetype", + "description": "the project id of the template", + "name": "projectid", "type": "string" }, { - "description": "VMware only: true if template is deployed without orchestrating disks and networks but \"as-is\" defined in the template.", - "name": "deployasis", - "type": "boolean" + "description": "the processor bit size", + "name": "bits", + "type": "int" }, { - "description": "the project name of the template", - "name": "project", + "description": "the template display text", + "name": "displaytext", "type": "string" }, { - "description": "true if template is sshkey enabled, false otherwise", - "name": "sshkeyenabled", - "type": "boolean" - }, - { - "description": "true if the template is ready to be deployed from, false otherwise.", - "name": "isready", - "type": "boolean" + "description": "the template name", + "name": "name", + "type": "string" }, { - "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", - "name": "directdownload", - "type": "boolean" + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" }, { - "description": "the ID of the OS type for this template.", - "name": "ostypeid", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the template display text", - "name": "displaytext", - "type": "string" + "description": "Lists the download progress of a template across all secondary storages", + "name": "downloaddetails", + "type": "list" }, { - "description": "the template name", - "name": "name", + "description": "the name of the secondary storage host for the template", + "name": "hostname", "type": "string" }, { - "description": "true if the ISO is bootable, false otherwise", - "name": "bootable", + "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", + "name": "isdynamicallyscalable", "type": "boolean" }, { - "description": "the ID of the secondary storage host for the template", - "name": "hostid", + "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": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { @@ -1172,82 +1190,124 @@ "type": "string" }, { - "description": "true if the reset password feature is enabled, false otherwise", - "name": "passwordenabled", + "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", + "name": "directdownload", "type": "boolean" }, { - "description": "the project id of the template", - "name": "projectid", + "description": "the project name of the template", + "name": "project", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the status of the template", + "name": "status", + "type": "string" }, { - "description": "checksum of the template", - "name": "checksum", + "description": "the name of the domain to which the template belongs", + "name": "domain", "type": "string" }, { - "description": "true if this template is a featured template, false otherwise", - "name": "isfeatured", + "description": "the tag of this template", + "name": "templatetag", + "type": "string" + }, + { + "description": "true if template requires HVM enabled, false otherwise", + "name": "requireshvm", "type": "boolean" }, { - "description": "the URL which the template/iso is registered from", - "name": "url", + "description": "the ID of the OS type for this template.", + "name": "ostypeid", "type": "string" }, { - "description": "the physical size of the template", - "name": "physicalsize", - "type": "long" + "description": "the account id to which the template belongs", + "name": "accountid", + "type": "string" }, + {}, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "true if the ISO is bootable, false otherwise", + "name": "bootable", + "type": "boolean" }, { - "description": "the processor bit size", - "name": "bits", - "type": "int" + "description": "true if the template is managed across all Zones, false otherwise", + "name": "crossZones", + "type": "boolean" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the ID of the secondary storage host for the template", + "name": "hostid", + "type": "string" }, { - "description": "true if the template is extractable, false otherwise", - "name": "isextractable", + "description": "the URL which the template/iso is registered from", + "name": "url", + "type": "string" + }, + {}, + { + "description": "the name of the zone for this template", + "name": "zonename", + "type": "string" + }, + { + "description": "the name of the OS type for this template.", + "name": "ostypename", + "type": "string" + }, + { + "description": "true if the template is ready to be deployed from, false otherwise.", + "name": "isready", "type": "boolean" }, { - "description": "the ID of the domain to which the template belongs", - "name": "domainid", + "description": "the format of the template.", + "name": "format", + "type": "imageformat" + }, + { + "description": "if Datadisk template, then id of the root disk template this template belongs to", + "name": "parenttemplateid", "type": "string" }, { - "description": "the date this template was removed", - "name": "removed", - "type": "date" + "description": "true if the reset password feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" }, { "description": "the date this template was created", "name": "created", "type": "date" }, + { + "description": "the template ID of the parent template if present", + "name": "sourcetemplateid", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "the list of resource tags associated", "name": "tags", "response": [ { - "description": "resource type", - "name": "resourcetype", + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { @@ -1255,14 +1315,19 @@ "name": "value", "type": "string" }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, { "description": "id of the resource", "name": "resourceid", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { @@ -1271,8 +1336,8 @@ "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { @@ -1281,48 +1346,47 @@ "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", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" } ], "type": "set" }, { - "description": "additional key/value details tied with template", - "name": "details", + "description": "VMware only: additional key/value details tied with deploy-as-is template", + "name": "deployasisdetails", "type": "map" }, { - "description": "the name of the OS type for this template.", - "name": "ostypename", + "description": "true if template is sshkey enabled, false otherwise", + "name": "sshkeyenabled", + "type": "boolean" + }, + { + "description": "the type of the template", + "name": "templatetype", "type": "string" }, { - "description": "the template ID of the parent template if present", - "name": "sourcetemplateid", + "description": "the ID of the domain to which the template belongs", + "name": "domainid", "type": "string" }, { - "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", - "name": "isdynamicallyscalable", + "description": "true if the template is extractable, false otherwise", + "name": "isextractable", "type": "boolean" }, - {}, { - "description": "the account name to which the template belongs", - "name": "account", - "type": "string" + "description": "true if this template is a featured template, false otherwise", + "name": "isfeatured", + "type": "boolean" + }, + { + "description": "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 public template, false otherwise", @@ -1330,9 +1394,14 @@ "type": "boolean" }, { - "description": "the name of the domain to which the template belongs", - "name": "domain", - "type": "string" + "description": "the date this template was removed", + "name": "removed", + "type": "date" + }, + { + "description": "the physical size of the template", + "name": "physicalsize", + "type": "long" }, { "description": "the UUID of the latest async job acting on this object", @@ -1340,55 +1409,48 @@ "type": "string" }, { - "description": "VMware only: additional key/value details tied with deploy-as-is template", - "name": "deployasisdetails", - "type": "map" - }, - { - "description": "true if template requires HVM enabled, false otherwise", - "name": "requireshvm", - "type": "boolean" - }, - { - "description": "the ID of the zone for this template", - "name": "zoneid", + "description": "checksum of the template", + "name": "checksum", "type": "string" - }, + } + ] + }, + { + "description": "Deletes a autoscale vm profile.", + "isasync": true, + "name": "deleteAutoScaleVmProfile", + "params": [ { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", - "type": "string" - }, + "description": "the ID of the autoscale profile", + "length": 255, + "name": "id", + "related": "createAutoScaleVmProfile,listAutoScaleVmProfiles,updateAutoScaleVmProfile", + "required": true, + "type": "uuid" + } + ], + "response": [ { - "description": "the status of the template", - "name": "status", - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, { - "description": "the account id to which the template belongs", - "name": "accountid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - { - "description": "the format of the template.", - "name": "format", - "type": "imageformat" - }, + {}, {}, { - "description": "the name of the zone for this template", - "name": "zonename", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, { - "description": "Lists the download progress of a template across all secondary storages", - "name": "downloaddetails", - "type": "list" - }, - { - "description": "the name of the secondary storage host for the template", - "name": "hostname", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ] }, @@ -1397,13 +1459,6 @@ "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": "Whether to attempt reconnection with host/agent after successful deployment of certificate. When option is not provided, configured global setting is used", "length": 255, @@ -1415,57 +1470,20 @@ "description": "The host/agent uuid to which the certificate has to be provisioned (issued and propagated)", "length": 255, "name": "hostid", - "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,prepareHostForMaintenance,reconnectHost,updateHost,addBaremetalHost,listExternalLoadBalancers", + "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,prepareHostForMaintenance,reconnectHost,updateHost", "required": true, "type": "uuid" - } - ], - "response": [ - {}, - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - }, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - } - ], - "since": "4.11.0" - }, - { - "description": "Deletes a autoscale vm profile.", - "isasync": true, - "name": "deleteAutoScaleVmProfile", - "params": [ - { - "description": "the ID of the autoscale profile", + "description": "Name of the CA service provider, otherwise the default configured provider plugin will be used", "length": 255, - "name": "id", - "related": "createAutoScaleVmProfile,listAutoScaleVmProfiles,updateAutoScaleVmProfile", - "required": true, - "type": "uuid" + "name": "provider", + "required": false, + "type": "string" } ], "response": [ - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, + {}, {}, { "description": "the UUID of the latest async job acting on this object", @@ -1482,8 +1500,13 @@ "name": "jobstatus", "type": "integer" }, - {} - ] + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + } + ], + "since": "4.11.0" }, { "description": "Adds an external firewall appliance", @@ -1491,12 +1514,11 @@ "name": "addExternalFirewall", "params": [ { - "description": "Zone in which to add the external firewall appliance.", + "description": "Password of the external firewall appliance.", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "password", "required": true, - "type": "uuid" + "type": "string" }, { "description": "Username of the external firewall appliance.", @@ -1506,25 +1528,26 @@ "type": "string" }, { - "description": "Password of the external firewall appliance.", + "description": "URL of the external firewall appliance.", "length": 255, - "name": "password", + "name": "url", "required": true, "type": "string" }, { - "description": "URL of the external firewall appliance.", + "description": "Zone in which to add the external firewall appliance.", "length": 255, - "name": "url", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": true, - "type": "string" + "type": "uuid" } ], "related": "listExternalFirewalls", "response": [ { - "description": "the management IP address of the external firewall", - "name": "ipaddress", + "description": "the public interface of the external firewall", + "name": "publicinterface", "type": "string" }, { @@ -1537,48 +1560,45 @@ "name": "timeout", "type": "string" }, - { - "description": "the public interface of the external firewall", - "name": "publicinterface", - "type": "string" - }, - { - "description": "the private interface of the external firewall", - "name": "privateinterface", - "type": "string" - }, + {}, { "description": "the zone ID of the external firewall", "name": "zoneid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the ID of the external firewall", + "name": "id", + "type": "string" }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, + { + "description": "the number of times to retry requests to the external firewall", + "name": "numretries", + "type": "string" + }, { "description": "the username that's used to log in to the external firewall", "name": "username", "type": "string" }, { - "description": "the number of times to retry requests to the external firewall", - "name": "numretries", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, { "description": "the usage interface of the external firewall", "name": "usageinterface", "type": "string" }, { - "description": "the ID of the external firewall", + "description": "the ID of the network device", "name": "id", "type": "string" }, @@ -1587,52 +1607,16 @@ "name": "privatezone", "type": "string" }, - {}, - {}, - { - "description": "the ID of the network device", - "name": "id", - "type": "string" - } - ] - }, - { - "description": "Deletes a F5 external load balancer appliance added in a zone.", - "isasync": false, - "name": "deleteExternalLoadBalancer", - "params": [ - { - "description": "Id of the external loadbalancer appliance.", - "length": 255, - "name": "id", - "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,prepareHostForMaintenance,reconnectHost,updateHost,addBaremetalHost,listExternalLoadBalancers", - "required": true, - "type": "uuid" - } - ], - "response": [ - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the private interface of the external firewall", + "name": "privateinterface", "type": "string" }, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the management IP address of the external firewall", + "name": "ipaddress", "type": "string" - }, - {} + } ] }, { @@ -1641,47 +1625,57 @@ "name": "listVirtualMachinesMetrics", "params": [ { - "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 by the High Availability offering; true if filtering VMs with HA enabled; false for VMs with HA disabled", "length": 255, - "name": "details", + "name": "haenable", "required": false, - "type": "list" + "since": "4.15", + "type": "boolean" }, { - "description": "the target hypervisor for the template", + "description": "list by the service offering", "length": 255, - "name": "hypervisor", + "name": "serviceofferingid", + "related": "createServiceOffering,updateServiceOffering,listServiceOfferings", + "required": false, + "since": "4.4", + "type": "uuid" + }, + { + "description": "name of the virtual machine (a substring match is made against the parameter value, data for all matching VMs will be returned)", + "length": 255, + "name": "name", "required": false, "type": "string" }, { - "description": "list only resources belonging to the domain specified", + "description": "list vms by ssh keypair name", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", + "name": "keypair", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "the availability zone ID", + "description": "list vms by template", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "templateid", + "related": "prepareTemplate,listIsos,registerIso,updateIso,copyTemplate,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", "required": false, "type": "uuid" }, { - "description": "list vms by iso", + "description": "the group ID", "length": 255, - "name": "isoid", + "name": "groupid", + "related": "createInstanceGroup,listInstanceGroups,updateInstanceGroup", "required": false, "type": "uuid" }, { - "description": "the user ID that created the VM and is under the account that owns the VM", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "userid", - "related": "createUser,disableUser,enableUser,getUser,listUsers,lockUser,updateUser", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", "required": false, "type": "uuid" }, @@ -1694,57 +1688,48 @@ "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 host ID", + "description": "the cluster ID", "length": 255, - "name": "hostid", - "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,prepareHostForMaintenance,reconnectHost,updateHost,addBaremetalHost,listExternalLoadBalancers", + "name": "clusterid", + "related": "addCluster,listClusters,updateCluster", "required": false, "type": "uuid" }, { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "displayvm", + "name": "isrecursive", "required": false, - "since": "4.4", "type": "boolean" }, { - "description": "the security group ID", + "description": "", "length": 255, - "name": "securitygroupid", - "related": "createSecurityGroup,listSecurityGroups,updateSecurityGroup", + "name": "pagesize", "required": false, - "since": "4.15", - "type": "uuid" + "type": "integer" }, { - "description": "list by network type; true if need to list vms using Virtual Network, false otherwise", + "description": "list by the backup offering", "length": 255, - "name": "forvirtualnetwork", + "name": "backupofferingid", "required": false, - "type": "boolean" + "since": "4.17", + "type": "uuid" }, { - "description": "List by keyword", + "description": "List resources by tags (key/value pairs)", "length": 255, - "name": "keyword", + "name": "tags", "required": false, - "type": "string" + "type": "map" }, { "description": "the storage ID where vm's volumes belong to", @@ -1755,120 +1740,135 @@ "type": "uuid" }, { - "description": "list by network id", + "description": "state of the virtual machine. Possible values are: Running, Stopped, Present, Destroyed, Expunged. Present is used for the state equal not destroyed.", "length": 255, - "name": "networkid", - "related": "createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listF5LoadBalancerNetworks,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listSrxFirewallNetworks,listBrocadeVcsDeviceNetworks", + "name": "state", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false", + "description": "flag to display the resource icon for VMs", "length": 255, - "name": "listall", + "name": "showicon", "required": false, + "since": "4.16.0.0", "type": "boolean" }, { - "description": "", + "description": "list by network id", "length": 255, - "name": "page", + "name": "networkid", + "related": "createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listSrxFirewallNetworks,listBrocadeVcsDeviceNetworks", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "list objects by project", + "description": "the availability zone ID", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "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": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "name", + "name": "listall", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "list vms by template", + "description": "list vms by vpc", "length": 255, - "name": "templateid", - "related": "prepareTemplate,listIsos,registerIso,updateIso,copyTemplate,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", + "name": "vpcid", + "related": "createVPC,listVPCs,updateVPC,createVPC,listVPCs,updateVPC,migrateVPC", "required": false, "type": "uuid" }, { - "description": "List resources by tags (key/value pairs)", + "description": "List by keyword", "length": 255, - "name": "tags", + "name": "keyword", "required": false, - "type": "map" + "type": "string" }, { - "description": "list vms by affinity group", + "description": "list by network type; true if need to list vms using Virtual Network, false otherwise", "length": 255, - "name": "affinitygroupid", - "related": "createAffinityGroup,listAffinityGroups", + "name": "forvirtualnetwork", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "list by the High Availability offering; true if filtering VMs with HA enabled; false for VMs with HA disabled", + "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": "haenable", + "name": "details", "required": false, - "since": "4.15", - "type": "boolean" + "type": "list" }, { - "description": "list vms by vpc", + "description": "the security group ID", "length": 255, - "name": "vpcid", - "related": "createVPC,listVPCs,updateVPC,createVPC,listVPCs,updateVPC,migrateVPC", + "name": "securitygroupid", + "related": "createSecurityGroup,listSecurityGroups,updateSecurityGroup", "required": false, + "since": "4.15", "type": "uuid" }, { - "description": "the group ID", + "description": "the user ID that created the VM and is under the account that owns the VM", "length": 255, - "name": "groupid", - "related": "createInstanceGroup,listInstanceGroups,updateInstanceGroup", + "name": "userid", + "related": "createUser,disableUser,enableUser,getUser,listUsers,lockUser,updateUser", "required": false, "type": "uuid" }, { - "description": "the pod ID", + "description": "list vms by affinity group", "length": 255, - "name": "podid", - "related": "listPods,updatePod,createManagementNetworkIpRange", + "name": "affinitygroupid", + "related": "createAffinityGroup,listAffinityGroups", "required": false, "type": "uuid" }, { - "description": "the IDs of the virtual machines, mutually exclusive with id", + "description": "the host ID", "length": 255, - "name": "ids", - "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVmNicIp,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance", + "name": "hostid", + "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,prepareHostForMaintenance,reconnectHost,updateHost", "required": false, - "since": "4.4", - "type": "list" + "type": "uuid" }, { - "description": "flag to display the resource icon for VMs", + "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": "showicon", + "name": "accumulate", "required": false, - "since": "4.16.0.0", + "since": "4.17.0", "type": "boolean" }, { - "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 pod ID", "length": 255, - "name": "state", + "name": "podid", + "related": "listPods,updatePod,createManagementNetworkIpRange", "required": false, - "type": "string" + "type": "uuid" + }, + { + "description": "list vms by iso", + "length": 255, + "name": "isoid", + "required": false, + "type": "uuid" + }, + { + "description": "list objects by project; if projectid=-1 lists All VMs", + "length": 255, + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "required": false, + "type": "uuid" }, { "description": "list resources by account. Must be used with the domainId parameter.", @@ -1878,71 +1878,89 @@ "type": "string" }, { - "description": "list by the service offering", + "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", "length": 255, - "name": "serviceofferingid", - "related": "createServiceOffering,updateServiceOffering,listServiceOfferings", + "name": "displayvm", "required": false, "since": "4.4", - "type": "uuid" + "type": "boolean" }, { - "description": "list vms by ssh keypair name", + "description": "the IDs of the virtual machines, mutually exclusive with id", "length": 255, - "name": "keypair", + "name": "ids", + "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVmNicIp,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance", + "required": false, + "since": "4.4", + "type": "list" + }, + { + "description": "the target hypervisor for the template", + "length": 255, + "name": "hypervisor", "required": false, "type": "string" } ], - "related": "", + "related": "listVirtualMachinesMetrics", "response": [ { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", + "type": "string" }, { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", - "type": "string" + "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", + "type": "long" }, { "description": "the list of nics associated with vm", "name": "nic", "response": [ { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the ID of the nic", + "name": "id", "type": "string" }, { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "description": "the traffic type of the nic", + "name": "traffictype", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "the IPv6 address of network", + "name": "ip6address", "type": "string" }, { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", "type": "string" }, { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", "type": "string" }, { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", "type": "string" }, { @@ -1951,9 +1969,9 @@ "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 extra dhcp options on the nic", @@ -1961,28 +1979,18 @@ "type": "list" }, { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", - "type": "string" - }, - { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - }, - { - "description": "the ID of the nic", - "name": "id", + "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 cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "the gateway of the nic", - "name": "gateway", + "description": "the ID of the corresponding network", + "name": "networkid", "type": "string" }, { @@ -1990,14 +1998,19 @@ "name": "ipaddresses", "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": "Type of adapter if available", - "name": "adaptertype", + "description": "true if nic is default, false otherwise", + "name": "macaddress", "type": "string" }, { @@ -2006,61 +2019,76 @@ "type": "string" }, { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "the IPv6 address of network", - "name": "ip6address", + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", + "description": "the name of the corresponding network", + "name": "networkname", "type": "string" }, { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "the gateway of the nic", + "name": "gateway", "type": "string" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", "type": "string" }, { "description": "the isolated private VLAN if available", "name": "isolatedpvlan", "type": "integer" + }, + { + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" } ], "type": "set" }, { - "description": "network write in MiB", - "name": "networkwrite", + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", "type": "string" }, { - "description": "the total memory capacity in GiB", - "name": "memorytotal", + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", "type": "string" }, { - "description": "the ID of the disk offering of the virtual machine", - "name": "diskofferingid", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, { - "description": "the name of the host for the virtual machine", - "name": "hostname", + "description": "OS name of the vm", + "name": "osdisplayname", "type": "string" }, { @@ -2069,144 +2097,206 @@ "type": "boolean" }, { - "description": "the name of the disk offering of the virtual machine", - "name": "diskofferingname", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the project id of the vm", + "name": "projectid", "type": "string" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", - "type": "string" + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" }, { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" + }, + { + "description": "Guest vm Boot Mode", + "name": "bootmode", "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", + "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "disk write in MiB", + "name": "diskwrite", + "type": "string" }, - {}, { - "description": "the account associated with the virtual machine", - "name": "account", + "description": "the name of the host for the virtual machine", + "name": "hostname", "type": "string" }, { - "description": "the VM's primary IP address", - "name": "ipaddress", + "description": "device type of the root volume", + "name": "rootdevicetype", "type": "string" }, + { + "description": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" + }, + {}, { "description": "the pool type of the virtual machine", "name": "pooltype", "type": "string" }, { - "description": "the internal memory that's free in vm or zero if it can not be calculated", - "name": "memoryintfreekbs", - "type": "long" - }, - { - "description": "the read (bytes) of disk on the vm", - "name": "diskkbsread", - "type": "long" + "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", + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", "type": "boolean" }, { - "description": "network read in MiB", - "name": "networkread", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "the ID of the disk offering of the virtual machine", + "name": "diskofferingid", "type": "string" }, + {}, { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" - }, - { - "description": "the speed of each cpu", - "name": "cpuspeed", - "type": "integer" + "description": "the account associated with the virtual machine", + "name": "account", + "type": "string" }, { - "description": "the total cpu capacity in Ghz", - "name": "cputotal", + "description": "the name of the disk offering of the virtual machine", + "name": "diskofferingname", "type": "string" }, { - "description": "OS name of the vm", - "name": "osdisplayname", + "description": "the state of the virtual machine", + "name": "state", "type": "string" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", + "description": "the ID of 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 ID of the host for the virtual machine", + "name": "hostid", + "type": "string" }, - {}, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", + "type": "string" }, { - "description": "the read (io) of disk on the vm", - "name": "diskioread", + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", "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 domain ID of the affinity group", - "name": "domainid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the type of the affinity group", - "name": "type", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the domain name of the affinity group", - "name": "domain", + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" + }, + { + "description": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", + "response": [ { "description": "virtual machine IDs associated with this affinity group", "name": "virtualmachineIds", "type": "list" }, { - "description": "the name of the affinity group", - "name": "name", + "description": "the project name of the affinity group", + "name": "project", + "type": "string" + }, + { + "description": "the ID of the affinity group", + "name": "id", + "type": "string" + }, + { + "description": "the account owning the affinity group", + "name": "account", "type": "string" }, { @@ -2220,116 +2310,127 @@ "type": "string" }, { - "description": "the account owning the affinity group", - "name": "account", + "description": "the type of the affinity group", + "name": "type", "type": "string" }, { - "description": "the ID of the affinity group", - "name": "id", + "description": "the name of the affinity group", + "name": "name", "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 ID of the affinity group", + "name": "domainid", "type": "string" } ], "type": "set" }, { - "description": "the target memory in vm", - "name": "memorytargetkbs", - "type": "long" + "description": "OS type id of the vm", + "name": "ostypeid", + "type": "string" }, { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" + "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 amount of the vm's CPU currently used", + "name": "cpuused", "type": "string" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", - "type": "string" + "description": "the total disk iops", + "name": "diskiopstotal", + "type": "long" }, { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" + "description": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" }, { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" }, { - "description": "the project name of the vm", - "name": "project", - "type": "string" + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" }, { - "description": "ssh key-pair", - "name": "keypair", + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" + }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "network write in MiB", + "name": "networkwrite", "type": "string" }, { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", "type": "string" }, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", + "description": "network read in MiB", + "name": "networkread", "type": "string" }, + {}, { "description": "Guest vm Boot Type", "name": "boottype", "type": "string" }, { - "description": "the write (bytes) of disk on the vm", - "name": "diskkbswrite", - "type": "long" - }, - { - "description": "the memory used by the vm", - "name": "memorykbs", - "type": "long" + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", + "type": "string" }, { - "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 incoming network traffic on the vm", - "name": "networkkbsread", + "description": "the VM's disk read in KiB", + "name": "diskkbsread", "type": "long" }, { - "description": "the group ID of the virtual machine", - "name": "groupid", + "description": "Os type ID of the virtual machine", + "name": "guestosid", "type": "string" }, { - "description": "the user's name who deployed the virtual machine", - "name": "username", + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", "type": "string" }, { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", "type": "string" }, { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", + "description": "the user's name who deployed the virtual machine", + "name": "username", "type": "string" }, { @@ -2338,131 +2439,84 @@ "type": "string" }, { - "description": "the group name of the virtual machine", - "name": "group", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "the total memory capacity in GiB", + "name": "memorytotal", "type": "string" }, { - "description": "State of the Service from LB rule", - "name": "servicestate", + "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": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the 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 VM's primary IP address", + "name": "ipaddress", + "type": "string" }, { - "description": "the number of cpu this virtual machine is running with", - "name": "cpunumber", - "type": "integer" + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" }, { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", + "description": "the total cpu capacity in Ghz", + "name": "cputotal", "type": "string" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "the ID of the availablility zone for the virtual machine", + "name": "zoneid", "type": "string" }, { - "description": "the project id of the vm", - "name": "projectid", + "description": "the user's ID who deployed the virtual machine", + "name": "userid", "type": "string" }, { - "description": "device ID of the root volume", - "name": "rootdeviceid", + "description": "the read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" + }, + { + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" + }, + { + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" + }, + { + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" + }, + { + "description": "disk read in MiB", + "name": "diskread", + "type": "string" + }, + { + "description": "State of the Service from LB rule", + "name": "servicestate", + "type": "string" + }, + { + "description": "the memory used by the VM in KiB", + "name": "memorykbs", "type": "long" }, { "description": "list of security groups associated with the virtual machine", "name": "securitygroup", "response": [ - { - "description": "the description of the security group", - "name": "description", - "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 project name of the group", - "name": "project", - "type": "string" - }, - { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" - }, { "description": "the list of resource tags associated with the rule", "name": "tags", @@ -2472,24 +2526,29 @@ "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 name where tag belongs to", - "name": "project", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "tag value", + "name": "value", "type": "string" }, { @@ -2503,59 +2562,94 @@ "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "tag value", - "name": "value", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the project name where tag belongs to", + "name": "project", "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 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": "account owning the security group rule", + "name": "account", + "type": "string" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, { "description": "security group name", "name": "securitygroupname", "type": "string" }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ - { - "description": "tag value", - "name": "value", - "type": "string" - }, { "description": "id of the resource", "name": "resourceid", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { @@ -2569,8 +2663,18 @@ "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", "type": "string" }, { @@ -2582,54 +2686,14 @@ "description": "the project name where tag belongs to", "name": "project", "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" } ], "type": "set" }, - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "the 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 ending IP of the security group rule ", "name": "endport", "type": "integer" - }, - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, - { - "description": "account owning the security group rule", - "name": "account", - "type": "string" - }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" } ], "type": "set" @@ -2640,13 +2704,8 @@ "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", + "description": "the name of the security group", + "name": "name", "type": "string" }, { @@ -2654,14 +2713,9 @@ "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 code for the ICMP message response", @@ -2674,14 +2728,14 @@ "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 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", @@ -2689,19 +2743,19 @@ "type": "integer" }, { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, - { - "description": "security group name", - "name": "securitygroupname", + "description": "account owning the security group rule", + "name": "account", "type": "string" }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, { "description": "the account associated with the tag", "name": "account", @@ -2713,18 +2767,18 @@ "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { @@ -2733,68 +2787,67 @@ "type": "string" }, { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "resource type", + "name": "resourcetype", "type": "string" } ], "type": "set" + }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" } ], "type": "set" }, + { + "description": "the description of the security group", + "name": "description", + "type": "string" + }, + { + "description": "the domain ID of the security group", + "name": "domainid", + "type": "string" + }, + { + "description": "the project id of the group", + "name": "projectid", + "type": "string" + }, { "description": "the account owning the security group", "name": "account", "type": "string" + }, + { + "description": "the domain name of the security group", + "name": "domain", + "type": "string" } ], "type": "set" }, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", - "type": "string" - }, - { - "description": "the password (if exists) of the virtual machine", - "name": "password", - "type": "string" - }, - { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" - }, - {}, - { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", - "type": "string" - }, - { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", - "type": "string" - }, - { - "description": "OS type id of the vm", - "name": "ostypeid", + "description": "ssh key-pairs", + "name": "keypairs", "type": "string" }, { @@ -2802,93 +2855,57 @@ "name": "isoid", "type": "string" }, - { - "description": "device type of the root volume", - "name": "rootdevicetype", - "type": "string" - }, { "description": "the ID of the virtual machine", "name": "id", "type": "string" }, { - "description": "the vgpu type used by the virtual machine", - "name": "vgpu", - "type": "string" - }, - { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", - "type": "string" - }, - { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", - "type": "string" - }, - { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", "type": "boolean" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", + "description": "the project name of the vm", + "name": "project", "type": "string" }, { - "description": "the write (io) of disk on the vm", - "name": "diskiowrite", - "type": "long" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { - "description": "the total disk iops", - "name": "diskiopstotal", - "type": "long" - }, - { - "description": "disk write in MiB", - "name": "diskwrite", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "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": "disk read in MiB", - "name": "diskread", - "type": "string" + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "the group name of the virtual machine", + "name": "group", "type": "string" }, { - "description": "the state of the virtual machine", - "name": "state", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "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" } - ], - "since": "4.9.3" + ] }, { "description": "Lists hosts.", @@ -2896,305 +2913,251 @@ "name": "listHosts", "params": [ { - "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": "lists hosts existing in particular cluster", + "description": "the Zone ID for the host", "length": 255, - "name": "clusterid", - "related": "addCluster,listClusters,updateCluster", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, "type": "uuid" }, { - "description": "list hosts by its out-of-band management interface's power state. Its value can be one of [On, Off, Unknown]", + "description": "comma separated list of host details requested, value can be a list of [ min, all, capacity, events, stats]", "length": 255, - "name": "outofbandmanagementpowerstate", + "name": "details", "required": false, - "type": "string" + "type": "list" }, { - "description": "the state of the host", + "description": "the host type", "length": 255, - "name": "state", + "name": "type", "required": false, "type": "string" }, { - "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": "hypervisor type of host: XenServer,KVM,VMware,Hyperv,BareMetal,Simulator", + "description": "lists hosts existing in particular cluster", "length": 255, - "name": "hypervisor", + "name": "clusterid", + "related": "addCluster,listClusters,updateCluster", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "the host type", + "description": "the id of the host", "length": 255, - "name": "type", + "name": "id", + "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,prepareHostForMaintenance,reconnectHost,updateHost", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "the id of the host", + "description": "hypervisor type of host: XenServer,KVM,VMware,Hyperv,BareMetal,Simulator", "length": 255, - "name": "id", - "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,prepareHostForMaintenance,reconnectHost,updateHost,addBaremetalHost,listExternalLoadBalancers", + "name": "hypervisor", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "the Zone ID for the host", + "description": "the name of the host", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "name", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "comma separated list of host details requested, value can be a list of [ min, all, capacity, events, stats]", + "description": "if true, list only hosts dedicated to HA", "length": 255, - "name": "details", + "name": "hahost", "required": false, - "type": "list" + "type": "boolean" }, { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, { - "description": "if true, list only hosts dedicated to HA", + "description": "", "length": 255, - "name": "hahost", + "name": "pagesize", "required": false, - "type": "boolean" + "type": "integer" }, { - "description": "lists hosts in the same cluster as this VM and flag hosts with enough CPU/RAm to host this VM", + "description": "list hosts by resource state. Resource state represents current state determined by admin of host, value can be one of [Enabled, Disabled, Unmanaged, PrepareForMaintenance, ErrorInMaintenance, Maintenance, Error]", "length": 255, - "name": "virtualmachineid", - "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVmNicIp,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance", + "name": "resourcestate", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "the Pod ID for the host", + "description": "the state of the host", "length": 255, - "name": "podid", - "related": "listPods,updatePod,createManagementNetworkIpRange", + "name": "state", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "list hosts by resource state. Resource state represents current state determined by admin of host, value can be one of [Enabled, Disabled, Unmanaged, PrepareForMaintenance, ErrorInMaintenance, Maintenance, Error]", + "description": "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": "list hosts for which out-of-band management is enabled", + "description": "List by keyword", "length": 255, - "name": "outofbandmanagementenabled", + "name": "keyword", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "the name of the host", + "description": "lists hosts in the same cluster as this VM and flag hosts with enough CPU/RAm to host this VM", "length": 255, - "name": "name", + "name": "virtualmachineid", + "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVmNicIp,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance", "required": false, - "type": "string" + "type": "uuid" } ], - "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost,updateHost,addBaremetalHost,listExternalLoadBalancers", + "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost,updateHost", "response": [ { - "description": "capabilities of the host", - "name": "capabilities", + "description": "the Zone ID of the host", + "name": "zoneid", "type": "string" }, { - "description": "the incoming network traffic on the host", - "name": "networkkbsread", - "type": "long" + "description": "the cluster type of the cluster that host belongs to", + "name": "clustertype", + "type": "string" }, { - "description": "the OS category ID of the host", - "name": "oscategoryid", + "description": "the resource state of the host", + "name": "resourcestate", "type": "string" }, { - "description": "the host out-of-band management information", - "name": "outofbandmanagement", - "type": "outofbandmanagementresponse" + "description": "true if the host is disconnected. False otherwise.", + "name": "disconnected", + "type": "date" }, { - "description": "the amount of the host's CPU currently allocated", - "name": "cpuallocated", - "type": "string" + "description": "the incoming network traffic on the host", + "name": "networkkbsread", + "type": "long" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the OS category name of the host", + "name": "oscategoryname", "type": "string" }, { - "description": "events available for the host", - "name": "events", + "description": "the OS category ID of the host", + "name": "oscategoryid", "type": "string" }, { - "description": "comma-separated list of tags for the host", - "name": "hosttags", + "description": "the ID of the host", + "name": "id", "type": "string" }, { - "description": "the date and time the host was last pinged", - "name": "lastpinged", - "type": "date" + "description": "true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise", + "name": "hasenoughcapacity", + "type": "boolean" }, { - "description": "the total disk size of the host", - "name": "disksizetotal", - "type": "long" + "description": "the amount of the host's memory currently allocated in percentage", + "name": "memoryallocatedpercentage", + "type": "string" }, { - "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise", - "name": "hahost", - "type": "boolean" + "description": "the host HA information information", + "name": "hostha", + "type": "hostharesponse" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the amount of the host's memory currently allocated in bytes", + "name": "memoryallocatedbytes", + "type": "long" }, { - "description": "the management server ID of the host", - "name": "managementserverid", + "description": "the host version", + "name": "version", "type": "string" }, { - "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", - "name": "memorytotal", + "description": "the CPU speed of the host", + "name": "cpuspeed", "type": "long" }, { - "description": "the host type", - "name": "type", - "type": "type" + "description": "the number of CPU sockets on the host", + "name": "cpusockets", + "type": "integer" }, { - "description": "true if the host has capability to support UEFI boot", - "name": "ueficapability", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "the Pod ID of the host", - "name": "podid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the amount of the host's memory currently allocated in bytes", - "name": "memoryallocatedbytes", + "description": "the outgoing network traffic on the host", + "name": "networkkbswrite", "type": "long" }, { - "description": "the date and time the host was created", - "name": "created", - "type": "date" + "description": "the hypervisor version", + "name": "hypervisorversion", + "type": "string" }, { - "description": "the amount of the host's memory currently allocated in percentage", - "name": "memoryallocatedpercentage", + "description": "the cluster ID of the host", + "name": "clusterid", "type": "string" }, { - "description": "GPU cards present in the host", - "name": "gpugroup", - "response": [ - { - "description": "the list of enabled vGPUs", - "name": "vgpu", - "response": [ - { - "description": "Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type", - "name": "remainingcapacity", - "type": "long" - }, - { - "description": "Video RAM for this vGPU type", - "name": "videoram", - "type": "long" - }, - { - "description": "Model Name of vGPU", - "name": "vgputype", - "type": "string" - }, - { - "description": "Maximum Y resolution per display", - "name": "maxresolutiony", - "type": "long" - }, - { - "description": "Maximum displays per user", - "name": "maxheads", - "type": "long" - }, - { - "description": "Maximum X resolution per display", - "name": "maxresolutionx", - "type": "long" - }, - { - "description": "Maximum no. of vgpu per gpu card (pgpu)", - "name": "maxvgpuperpgpu", - "type": "long" - }, - { - "description": "Maximum vgpu can be created with this vgpu type on the given gpu group", - "name": "maxcapacity", - "type": "long" - } - ], - "type": "list" - }, - { - "description": "GPU cards present in the host", - "name": "gpugroupname", - "type": "string" - } - ], - "type": "list" + "description": "capabilities of the host", + "name": "capabilities", + "type": "string" }, { - "description": "the state of the host", - "name": "state", - "type": "status" + "description": "the date and time the host was removed", + "name": "removed", + "type": "date" }, { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", - "type": "long" + "description": "the amount of the host's CPU currently used", + "name": "cpuused", + "type": "string" }, { - "description": "true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise", - "name": "hasenoughcapacity", - "type": "boolean" + "description": "the CPU number of the host", + "name": "cpunumber", + "type": "integer" }, { "description": "true if local storage is active, false otherwise", @@ -3202,185 +3165,239 @@ "type": "boolean" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise", + "name": "hahost", "type": "boolean" }, { - "description": "true if the host is disconnected. False otherwise.", - "name": "disconnected", - "type": "date" - }, - {}, - { - "description": "the Zone ID of the host", - "name": "zoneid", + "description": "the Zone name of the host", + "name": "zonename", "type": "string" }, { - "description": "the last annotation set on this host by an admin", - "name": "annotation", - "type": "string" + "description": "the last time this host was annotated", + "name": "lastannotated", + "type": "date" }, { - "description": "the CPU number of the host", - "name": "cpunumber", - "type": "integer" + "description": "the amount of the host's memory after applying the mem.overprovisioning.factor", + "name": "memorywithoverprovisioning", + "type": "string" }, { - "description": "the name of the host", - "name": "name", + "description": "the management server ID of the host", + "name": "managementserverid", "type": "string" }, { - "description": "the outgoing network traffic on the host", - "name": "networkkbswrite", + "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", + "name": "memorytotal", "type": "long" }, { - "description": "the number of CPU sockets on the host", - "name": "cpusockets", - "type": "integer" + "description": "the state of the host", + "name": "state", + "type": "status" }, { - "description": "the 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 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 CPU currently allocated after applying the cpu.overprovisioning.factor", - "name": "cpuallocatedwithoverprovisioning", - "type": "string" + "description": "the date and time the host was created", + "name": "created", + "type": "date" }, + {}, { - "description": "the amount of the host's memory after applying the mem.overprovisioning.factor", - "name": "memorywithoverprovisioning", - "type": "string" + "description": "true if the host has capability to support UEFI boot", + "name": "ueficapability", + "type": "boolean" }, { - "description": "the cluster ID of the host", - "name": "clusterid", - "type": "string" + "description": "the host out-of-band management information", + "name": "outofbandmanagement", + "type": "outofbandmanagementresponse" }, { - "description": "the amount of the host's CPU currently allocated in percentage", - "name": "cpuallocatedpercentage", + "description": "the name of the host", + "name": "name", "type": "string" }, { - "description": "the hypervisor version", - "name": "hypervisorversion", + "description": "comma-separated list of tags for the host", + "name": "hosttags", "type": "string" }, - { - "description": "the host hypervisor", - "name": "hypervisor", - "type": "hypervisortype" - }, + {}, { "description": "the cpu average load on the host", "name": "cpuloadaverage", "type": "double" }, { - "description": "the host HA information information", - "name": "hostha", - "type": "hostharesponse" + "description": "true if this host is suitable(has enough capacity and satisfies all conditions like hosttags, max guests vm limit etc) to migrate a VM to it , false otherwise", + "name": "suitableformigration", + "type": "boolean" }, { - "description": "the amount of the host's memory currently allocated", - "name": "memoryallocated", + "description": "the date and time the host was last pinged", + "name": "lastpinged", + "type": "date" + }, + { + "description": "the total disk size of the host", + "name": "disksizetotal", "type": "long" }, { - "description": "the Zone name of the host", - "name": "zonename", + "description": "the cluster name of the host", + "name": "clustername", "type": "string" }, { - "description": "the amount of the host's CPU currently used", - "name": "cpuused", - "type": "string" + "description": "the amount of the host's CPU currently allocated in MHz", + "name": "cpuallocatedvalue", + "type": "long" }, { - "description": "the ID of the host", - "name": "id", + "description": "the host hypervisor", + "name": "hypervisor", + "type": "hypervisortype" + }, + { + "description": "events available for the host", + "name": "events", "type": "string" }, { - "description": "the amount of the host's memory currently used", - "name": "memoryused", + "description": "the amount of the host's memory currently allocated", + "name": "memoryallocated", "type": "long" }, { - "description": "the Pod name of the host", - "name": "podname", - "type": "string" + "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": "Maximum displays per user", + "name": "maxheads", + "type": "long" + }, + { + "description": "Maximum X resolution per display", + "name": "maxresolutionx", + "type": "long" + }, + { + "description": "Maximum vgpu can be created with this vgpu type on the given gpu group", + "name": "maxcapacity", + "type": "long" + }, + { + "description": "Maximum no. of vgpu per gpu card (pgpu)", + "name": "maxvgpuperpgpu", + "type": "long" + }, + { + "description": "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" + }, + { + "description": "GPU cards present in the host", + "name": "gpugroupname", + "type": "string" + } + ], + "type": "list" }, { - "description": "the host version", - "name": "version", + "description": "the admin that annotated this host", + "name": "username", "type": "string" }, - {}, { - "description": "the CPU speed of the host", - "name": "cpuspeed", + "description": "the host's currently allocated disk size", + "name": "disksizeallocated", "type": "long" }, { - "description": "the date and time the host was removed", - "name": "removed", - "type": "date" + "description": "the IP address of the host", + "name": "ipaddress", + "type": "string" }, { - "description": "the cluster type of the cluster that host belongs to", - "name": "clustertype", + "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", + "name": "cpuallocatedwithoverprovisioning", "type": "string" }, { - "description": "Host details in key/value pairs.", - "name": "details", - "type": "map" + "description": "the Pod ID of the host", + "name": "podid", + "type": "string" }, { - "description": "true if this host is suitable(has enough capacity and satisfies all conditions like hosttags, max guests vm limit etc) to migrate a VM to it , false otherwise", - "name": "suitableformigration", - "type": "boolean" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the IP address of the host", - "name": "ipaddress", + "description": "the Pod name of the host", + "name": "podname", "type": "string" }, { - "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor", - "name": "cpuwithoverprovisioning", + "description": "the last annotation set on this host by an admin", + "name": "annotation", "type": "string" }, { - "description": "the last time this host was annotated", - "name": "lastannotated", - "type": "date" + "description": "the host type", + "name": "type", + "type": "type" }, { - "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 OS category name of the host", - "name": "oscategoryname", + "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor", + "name": "cpuwithoverprovisioning", "type": "string" }, { - "description": "the resource state of the host", - "name": "resourcestate", + "description": "the amount of the host's CPU currently allocated", + "name": "cpuallocated", "type": "string" } ] @@ -3407,41 +3424,49 @@ } ], "response": [ - {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, + {}, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - {}, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" - } - ] - }, + }, + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + } + ] + }, { "description": "List storage pools compatible with a vSphere storage policy", "isasync": false, "name": "listVsphereStoragePolicyCompatiblePools", "params": [ { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" + }, + { + "description": "ID of the zone", + "length": 255, + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": false, + "type": "uuid" }, { "description": "", @@ -3459,19 +3484,11 @@ "type": "uuid" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, - { - "description": "ID of the zone", + "description": "List by keyword", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" } ], "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", @@ -3482,143 +3499,183 @@ "type": "boolean" }, { - "description": "the overprovisionfactor for the storage pool", - "name": "overprovisionfactor", + "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": "the host's currently used disk size", + "name": "disksizeused", + "type": "long" + }, { "description": "the storage pool path", "name": "path", "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": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the scope of the storage pool", + "name": "scope", "type": "string" }, { - "description": "the Zone name of the storage pool", - "name": "zonename", + "description": "the ID of the cluster for the storage pool", + "name": "clusterid", "type": "string" }, { - "description": "the storage pool capabilities", - "name": "storagecapabilities", - "type": "map" + "description": "total min IOPS currently in use by volumes", + "name": "allocatediops", + "type": "long" }, { - "description": "the Pod ID of the storage pool", - "name": "podid", + "description": "the state of the storage pool", + "name": "state", + "type": "storagepoolstatus" + }, + { + "description": "the name of the storage pool", + "name": "name", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the Pod ID of the storage pool", + "name": "podid", + "type": "string" }, { - "description": "the IP address of the storage pool", - "name": "ipaddress", + "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 ID of the storage pool", + "name": "id", + "type": "string" }, { - "description": "the storage pool type", - "name": "type", + "description": "the Zone name of the storage pool", + "name": "zonename", "type": "string" }, - {}, { - "description": "IOPS CloudStack can provision from this storage pool", - "name": "capacityiops", + "description": "the total disk size of the storage pool", + "name": "disksizetotal", "type": "long" }, { - "description": "Storage provider for this pool", - "name": "provider", + "description": "the Pod name of the storage pool", + "name": "podname", "type": "string" }, { - "description": "the Zone ID of the storage pool", - "name": "zoneid", - "type": "string" + "description": "the storage pool capabilities", + "name": "storagecapabilities", + "type": "map" }, { - "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 host's currently used disk size", - "name": "disksizeused", + "description": "the host's currently allocated disk size", + "name": "disksizeallocated", "type": "long" }, { - "description": "the scope of the storage pool", - "name": "scope", + "description": "the storage pool type", + "name": "type", "type": "string" }, { - "description": "the name of the storage pool", - "name": "name", + "description": "the tags for the storage pool", + "name": "tags", "type": "string" }, { - "description": "the ID of the cluster for the storage pool", - "name": "clusterid", + "description": "the hypervisor type of the storage pool", + "name": "hypervisor", "type": "string" }, { - "description": "the hypervisor type of the storage pool", - "name": "hypervisor", + "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 ID of the storage pool", - "name": "id", + "description": "Storage provider for this pool", + "name": "provider", "type": "string" }, { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", + "description": "IOPS CloudStack can provision from this storage pool", + "name": "capacityiops", "type": "long" }, { "description": "the date and time the storage pool was created", "name": "created", "type": "date" - }, + } + ] + }, + { + "description": "Deletes an existing guest network IPv6 prefix.", + "isasync": true, + "name": "deleteGuestNetworkIpv6Prefix", + "params": [ { - "description": "total min IOPS currently in use by volumes", - "name": "allocatediops", - "type": "long" - }, + "description": "Id of the guest network IPv6 prefix", + "length": 255, + "name": "id", + "related": "createGuestNetworkIpv6Prefix,listGuestNetworkIpv6Prefixes", + "required": true, + "type": "uuid" + } + ], + "response": [ { - "description": "the Pod name of the storage pool", - "name": "podname", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, + {}, { - "description": "the name of the cluster for the storage pool", - "name": "clustername", + "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 this pool is suitable to migrate a volume, false otherwise", - "name": "suitableformigration", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } - ] + ], + "since": "4.17.0.0" }, { "description": "Updates a storage pool.", @@ -3642,19 +3699,12 @@ "type": "string" }, { - "description": "bytes CloudStack can provision from this storage pool", + "description": "IOPS CloudStack can provision from this storage pool", "length": 255, - "name": "capacitybytes", + "name": "capacityiops", "required": false, "type": "long" }, - { - "description": "comma-separated list of tags for the storage pool", - "length": 255, - "name": "tags", - "required": false, - "type": "list" - }, { "description": "the Id of the storage pool", "length": 255, @@ -3664,46 +3714,32 @@ "type": "uuid" }, { - "description": "IOPS CloudStack can provision from this storage pool", + "description": "bytes CloudStack can provision from this storage pool", "length": 255, - "name": "capacityiops", + "name": "capacitybytes", "required": false, "type": "long" + }, + { + "description": "comma-separated list of tags for the storage pool", + "length": 255, + "name": "tags", + "required": false, + "type": "list" } ], "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities", "response": [ { - "description": "the name of the storage pool", - "name": "name", - "type": "string" - }, - { - "description": "the IP address of the storage pool", - "name": "ipaddress", - "type": "string" - }, - {}, - { - "description": "the Pod ID of the storage pool", - "name": "podid", + "description": "the scope of the storage pool", + "name": "scope", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the Zone name of the storage pool", - "name": "zonename", + "description": "Storage provider for this pool", + "name": "provider", "type": "string" }, - { - "description": "the date and time the storage pool was created", - "name": "created", - "type": "date" - }, { "description": "the name of the cluster for the storage pool", "name": "clustername", @@ -3711,39 +3747,35 @@ }, {}, { - "description": "the storage pool capabilities", - "name": "storagecapabilities", - "type": "map" - }, - { - "description": "the Pod name of the storage pool", - "name": "podname", + "description": "the tags for the storage pool", + "name": "tags", "type": "string" }, { - "description": "true if this pool is suitable to migrate a volume, false otherwise", - "name": "suitableformigration", - "type": "boolean" + "description": "the ID of the storage pool", + "name": "id", + "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": "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 host's currently allocated disk size", + "name": "disksizeallocated", + "type": "long" }, { - "description": "total min IOPS currently in use by volumes", - "name": "allocatediops", - "type": "long" + "description": "the Zone name of the storage pool", + "name": "zonename", + "type": "string" }, { "description": "the current status of the latest async job acting on this object", @@ -3751,28 +3783,28 @@ "type": "integer" }, { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", - "type": "long" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the total disk size of the storage pool", - "name": "disksizetotal", - "type": "long" + "description": "the name of the storage pool", + "name": "name", + "type": "string" }, { - "description": "the overprovisionfactor for the storage pool", - "name": "overprovisionfactor", + "description": "the Pod name of the storage pool", + "name": "podname", "type": "string" }, { - "description": "the scope of the storage pool", - "name": "scope", + "description": "the storage pool type", + "name": "type", "type": "string" }, { - "description": "the storage pool path", - "name": "path", + "description": "the hypervisor type of the storage pool", + "name": "hypervisor", "type": "string" }, { @@ -3781,38 +3813,63 @@ "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 ID of the storage pool", - "name": "id", + "description": "total min IOPS currently in use by volumes", + "name": "allocatediops", + "type": "long" + }, + { + "description": "the IP address of the storage pool", + "name": "ipaddress", "type": "string" }, { - "description": "the storage pool type", - "name": "type", + "description": "the storage pool capabilities", + "name": "storagecapabilities", + "type": "map" + }, + { + "description": "the Pod ID of the storage pool", + "name": "podid", "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": "the Zone ID of the storage pool", + "name": "zoneid", + "type": "string" + }, { "description": "the ID of the cluster for the storage pool", "name": "clusterid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the storage pool path", + "name": "path", "type": "string" }, { - "description": "the Zone ID of the storage pool", - "name": "zoneid", + "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" } ], @@ -3823,14 +3880,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, @@ -3838,59 +3887,68 @@ "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 agent state of the system VM", - "name": "agentstate", + "description": "the Zone ID for the system VM", + "name": "zoneid", "type": "string" }, { - "description": "the host ID for the system VM", - "name": "hostid", + "description": "the private IP address for the system VM", + "name": "privateip", "type": "string" }, - {}, { - "description": "the hostname for the system VM", - "name": "hostname", + "description": "the job ID associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job.", + "name": "jobid", "type": "string" }, { - "description": "the system VM type", - "name": "systemvmtype", + "description": "the Pod ID for the system VM", + "name": "podid", "type": "string" }, { - "description": "the date and time the system VM was created", - "name": "created", - "type": "date" + "description": "the gateway for the system VM", + "name": "gateway", + "type": "string" }, + {}, { - "description": "public vlan range", - "name": "publicvlan", - "type": "list" + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" }, { - "description": "the job ID associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job.", - "name": "jobid", - "type": "string" + "description": "the last disconnected date of host", + "name": "disconnected", + "type": "date" }, { - "description": "the private netmask for the system VM", - "name": "privatenetmask", + "description": "the private MAC address for the system VM", + "name": "privatemacaddress", "type": "string" }, { - "description": "the ID of the system VM", - "name": "id", + "description": "the hostname for the system VM", + "name": "hostname", "type": "string" }, { - "description": "the Zone ID for the system VM", - "name": "zoneid", + "description": "the systemvm agent version", + "name": "version", "type": "string" }, { @@ -3899,99 +3957,98 @@ "type": "string" }, { - "description": "the public MAC address for the system VM", - "name": "publicmacaddress", + "description": "the public IP address for the system VM", + "name": "publicip", "type": "string" }, { - "description": "the 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": "the template name for the system VM", - "name": "templatename", + "description": "the network domain for the system VM", + "name": "networkdomain", "type": "string" }, { - "description": "the gateway for the system VM", - "name": "gateway", + "description": "the link local netmask for the system vm", + "name": "linklocalnetmask", "type": "string" }, { - "description": "the public netmask for the system VM", - "name": "publicnetmask", + "description": "the private netmask for the system VM", + "name": "privatenetmask", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the template name for the system VM", + "name": "templatename", + "type": "string" }, { - "description": "the second DNS for the system VM", - "name": "dns2", + "description": "the Pod name for the system VM", + "name": "podname", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", - "type": "string" + "description": "the date and time the system VM was created", + "name": "created", + "type": "date" }, { - "description": "the state of the system VM", - "name": "state", + "description": "the template ID for the system VM", + "name": "templateid", "type": "string" }, { - "description": "the link local MAC address for the system vm", - "name": "linklocalmacaddress", + "description": "the link local IP address for the system vm", + "name": "linklocalip", "type": "string" }, { - "description": "the public IP address for the system VM", - "name": "publicip", + "description": "the public MAC address for the system VM", + "name": "publicmacaddress", "type": "string" }, { - "description": "the private MAC address for the system VM", - "name": "privatemacaddress", + "description": "the ID of the system VM", + "name": "id", "type": "string" }, - {}, { - "description": "the Pod name for the system VM", - "name": "podname", - "type": "string" + "description": "public vlan range", + "name": "publicvlan", + "type": "list" }, { - "description": "the systemvm agent version", - "name": "version", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the Zone name for the system VM", - "name": "zonename", + "description": "the second DNS for the system VM", + "name": "dns2", "type": "string" }, { - "description": "the link local IP address for the system vm", - "name": "linklocalip", + "description": "the system VM type", + "name": "systemvmtype", "type": "string" }, { - "description": "the name of the system VM", - "name": "name", + "description": "the public netmask for the system VM", + "name": "publicnetmask", "type": "string" }, { - "description": "the private IP address for the system VM", - "name": "privateip", - "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 template ID for the system VM", - "name": "templateid", + "description": "the Zone name for the system VM", + "name": "zonename", "type": "string" }, { @@ -4000,24 +4057,24 @@ "type": "integer" }, { - "description": "the link local netmask for the system vm", - "name": "linklocalnetmask", - "type": "string" + "description": "the number of active console sessions for the console proxy system vm", + "name": "activeviewersessions", + "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the Pod ID for the system VM", - "name": "podid", + "description": "the state of the system VM", + "name": "state", "type": "string" }, { - "description": "the last disconnected date of host", - "name": "disconnected", - "type": "date" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { "description": "guest vlan range", @@ -4025,19 +4082,19 @@ "type": "string" }, { - "description": "the network domain for the system VM", - "name": "networkdomain", + "description": "the agent state of the system VM", + "name": "agentstate", "type": "string" }, { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", - "type": "boolean" + "description": "the link local MAC address for the system vm", + "name": "linklocalmacaddress", + "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the name of the system VM", + "name": "name", + "type": "string" } ] }, @@ -4054,18 +4111,19 @@ "type": "string" }, { - "description": "Creates the user under the specified account. If no account is specified, the username will be used as the account name.", + "description": "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": "account", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "Type of the account. Specify 0 for user, 1 for root admin, and 2 for domain admin", + "description": "", "length": 255, - "name": "accounttype", + "name": "page", "required": false, - "type": "short" + "type": "integer" }, { "description": "Creates the account under the specified role.", @@ -4076,24 +4134,23 @@ "type": "uuid" }, { - "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": "", + "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": "page", + "name": "account", "required": false, - "type": "integer" + "type": "string" }, { - "description": "", + "description": "Type of the account. Specify 0 for user, 1 for root admin, and 2 for domain admin", "length": 255, - "name": "pagesize", + "name": "accounttype", "required": false, "type": "integer" }, @@ -4105,31 +4162,25 @@ "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": "", "length": 255, - "name": "group", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { - "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" } ], "related": "searchLdap,listLdapUsers", "response": [ { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - {}, - { - "description": "The user's domain", - "name": "domain", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -4137,20 +4188,25 @@ "name": "email", "type": "string" }, + { + "description": "The user's lastname", + "name": "lastname", + "type": "string" + }, { "description": "The authentication source for this user as known to the system or empty if the user is not yet in cloudstack.", "name": "conflictingusersource", "type": "string" }, { - "description": "The user's lastname", - "name": "lastname", + "description": "The user's domain", + "name": "domain", "type": "string" }, { - "description": "The user's firstname", - "name": "firstname", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "The user's username", @@ -4159,59 +4215,60 @@ }, {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The user's firstname", + "name": "firstname", "type": "string" }, { "description": "The user's principle", "name": "principal", "type": "string" - } + }, + {} ], "since": "4.3.0" }, { - "description": "List dedicated zones.", + "description": "Lists all available networks.", "isasync": false, - "name": "listDedicatedZones", + "name": "listNetworks", "params": [ { - "description": "the ID of the domain associated with the zone", + "description": "the zone ID of the network", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, "type": "uuid" }, { - "description": "", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "page", + "name": "isrecursive", "required": false, - "type": "integer" + "type": "boolean" }, { - "description": "the name of the account associated with the zone. Must be used with domainId.", + "description": "list networks supporting certain services", "length": 255, - "name": "account", + "name": "supportedservices", "required": false, - "type": "string" + "type": "list" }, { - "description": "the ID of the Zone", + "description": "true if need to list only networks which support specifying IP ranges", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "specifyipranges", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "list dedicated zones by affinity group", + "description": "List networks by associated networks. Only available if create a Shared network.", "length": 255, - "name": "affinitygroupid", - "related": "createAffinityGroup,listAffinityGroups", + "name": "associatednetworkid", + "related": "createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listSrxFirewallNetworks,listBrocadeVcsDeviceNetworks", "required": false, + "since": "4.17.0", "type": "uuid" }, { @@ -4222,128 +4279,78 @@ "type": "integer" }, { - "description": "List by keyword", + "description": "the type of the network. Supported values are: isolated, l2, shared and all", "length": 255, - "name": "keyword", + "name": "type", "required": false, "type": "string" - } - ], - "related": "dedicateZone", - "response": [ - { - "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 domain ID to which the Zone is dedicated", - "name": "domainid", - "type": "string" }, { - "description": "the Name of the Zone", - "name": "zonename", - "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 current status of the latest async job acting 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 available networks.", - "isasync": false, - "name": "listNetworks", - "params": [ - { - "description": "the zone ID of the network", + "description": "list networks by ID", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "id", + "related": "createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listSrxFirewallNetworks,listBrocadeVcsDeviceNetworks", "required": false, "type": "uuid" }, { - "description": "list networks available for VM deployment", + "description": "list networks by restartRequired", "length": 255, - "name": "canusefordeploy", + "name": "restartrequired", "required": false, "type": "boolean" }, { - "description": "list networks supporting certain services", + "description": "the network belongs to VPC", "length": 255, - "name": "supportedservices", + "name": "forvpc", "required": false, - "type": "list" + "type": "boolean" }, { - "description": "", + "description": "the ID or VID of the network", "length": 255, - "name": "pagesize", + "name": "vlan", "required": false, - "type": "integer" + "since": "4.17.0", + "type": "string" }, { - "description": "list networks by physical network id", + "description": "List networks by VPC", "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork,listPhysicalNetworks,updatePhysicalNetwork", + "name": "vpcid", + "related": "createVPC,listVPCs,updateVPC,createVPC,listVPCs,updateVPC,migrateVPC", "required": false, "type": "uuid" }, { - "description": "flag to display the resource icon for networks", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "showicon", + "name": "account", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "true if network is system, false otherwise", + "description": "List resources by tags (key/value pairs)", "length": 255, - "name": "issystem", + "name": "tags", "required": false, - "type": "boolean" + "type": "map" }, { - "description": "list networks by ACL (access control list) type. Supported values are account and domain", + "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": "acltype", + "name": "networkfilter", "required": false, + "since": "4.17.0", "type": "string" }, { - "description": "", + "description": "true if network is system, false otherwise", "length": 255, - "name": "page", + "name": "issystem", "required": false, - "type": "integer" + "type": "boolean" }, { "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", @@ -4354,56 +4361,42 @@ "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 networks by restartRequired", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "restartrequired", + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", "required": false, - "type": "boolean" + "type": "uuid" }, { - "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" }, { - "description": "the type of the network. Supported values are: isolated, l2, shared and all", + "description": "list networks by ACL (access control list) type. Supported values are account and domain", "length": 255, - "name": "type", + "name": "acltype", "required": false, "type": "string" }, { - "description": "list objects by project", + "description": "list networks by physical network id", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "name": "physicalnetworkid", + "related": "createPhysicalNetwork,listPhysicalNetworks,updatePhysicalNetwork", "required": false, "type": "uuid" }, { - "description": "the network belongs to VPC", + "description": "list networks available for VM deployment", "length": 255, - "name": "forvpc", + "name": "canusefordeploy", "required": false, "type": "boolean" }, - { - "description": "list only resources belonging to the domain specified", - "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", - "required": false, - "type": "uuid" - }, { "description": "List by keyword", "length": 255, @@ -4412,26 +4405,19 @@ "type": "string" }, { - "description": "List resources by tags (key/value pairs)", + "description": "", "length": 255, - "name": "tags", + "name": "page", "required": false, - "type": "map" + "type": "integer" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller 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": "type of the traffic", - "length": 255, - "name": "traffictype", - "required": false, - "type": "string" - }, { "description": "list networks by network offering ID", "length": 255, @@ -4441,105 +4427,168 @@ "type": "uuid" }, { - "description": "list networks by ID", + "description": "flag to display the resource icon for networks", "length": 255, - "name": "id", - "related": "createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listF5LoadBalancerNetworks,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listSrxFirewallNetworks,listBrocadeVcsDeviceNetworks", + "name": "showicon", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "List networks by VPC", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "vpcid", - "related": "createVPC,listVPCs,updateVPC,createVPC,listVPCs,updateVPC,migrateVPC", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", "required": false, "type": "uuid" - }, - { - "description": "true if need to list only networks which support specifying IP ranges", - "length": 255, - "name": "specifyipranges", - "required": false, - "type": "boolean" } ], - "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listF5LoadBalancerNetworks,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listSrxFirewallNetworks,listBrocadeVcsDeviceNetworks", + "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listSrxFirewallNetworks,listBrocadeVcsDeviceNetworks", "response": [ + {}, { - "description": "availability of the network offering the network is created from", - "name": "networkofferingavailability", + "description": "list networks that are persistent", + "name": "ispersistent", + "type": "boolean" + }, + { + "description": "the second DNS for the network", + "name": "dns2", "type": "string" }, { - "description": "true if network can span multiple zones", - "name": "strechedl2subnet", - "type": "boolean" + "description": "state of the network", + "name": "state", + "type": "string" }, { - "description": "list networks available for vm deployment", - "name": "canusefordeploy", + "description": "true if network offering is ip conserve mode enabled", + "name": "networkofferingconservemode", "type": "boolean" }, { - "description": "the name of the zone the network belongs to", - "name": "zonename", + "description": "the domain name of the network owner", + "name": "domain", "type": "string" }, { - "description": "the network CIDR of the guest network configured with IP reservation. It is the summation of CIDR and RESERVED_IP_RANGE", - "name": "networkcidr", + "description": "The vlan of the network. This parameter is visible to ROOT admins only", + "name": "vlan", "type": "string" }, { - "description": "true if network offering is ip conserve mode enabled", - "name": "networkofferingconservemode", - "type": "boolean" + "description": "the name of the Network associated with this network", + "name": "associatednetwork", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the name of the Network associated with this private gateway", + "name": "associatednetwork", "type": "string" }, { - "description": "the network's IP range not to be used by CloudStack guest VMs and can be used for non CloudStack purposes", - "name": "reservediprange", + "description": "the type of the network", + "name": "type", "type": "string" }, { - "description": "true if users from subdomains can access the domain level network", - "name": "subdomainaccess", + "description": "the traffic type of the network", + "name": "traffictype", + "type": "string" + }, + { + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" + }, + { + "description": "acl type - access type to the network", + "name": "acltype", + "type": "string" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + }, + { + "description": "true if network is default, false otherwise", + "name": "isdefault", "type": "boolean" }, { - "description": "the network's gateway", - "name": "gateway", + "description": "Name of the VPC to which this network belongs", + "name": "vpcname", "type": "string" }, - {}, { "description": "If a network is enabled for 'streched l2 subnet' then represents zones on which network currently spans", "name": "zonesnetworkspans", "type": "set" }, + { + "description": "Broadcast domain type of the network", + "name": "broadcastdomaintype", + "type": "string" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" + }, + { + "description": "availability of the network offering the network is created from", + "name": "networkofferingavailability", + "type": "string" + }, + { + "description": "the name of the network", + "name": "name", + "type": "string" + }, + { + "description": "zone id of the network", + "name": "zoneid", + "type": "string" + }, + { + "description": "an optional field, whether to the display the network to the end user or not.", + "name": "displaynetwork", + "type": "boolean" + }, + {}, + { + "description": "true network requires restart", + "name": "restartrequired", + "type": "boolean" + }, + { + "description": "the first DNS for the network", + "name": "dns1", + "type": "string" + }, + { + "description": "the displaytext of the network", + "name": "displaytext", + "type": "string" + }, + { + "description": "The routing mode of network offering", + "name": "ip6routing", + "type": "string" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "true if network is system, false otherwise", - "name": "issystem", + "description": "If the network has redundant routers enabled", + "name": "redundantrouter", "type": "boolean" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" - }, - { - "description": "the owner of the network", - "name": "account", + "description": "VPC the network belongs to", + "name": "vpcid", "type": "string" }, { @@ -4548,38 +4597,43 @@ "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "ACL Id associated with the VPC network", + "name": "aclid", "type": "string" }, { - "description": "the displaytext of the network", - "name": "displaytext", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the details of the network", - "name": "details", - "type": "map" + "description": "display text of the network offering the network is created from", + "name": "networkofferingdisplaytext", + "type": "string" }, { - "description": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR", - "name": "cidr", + "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": "name of the network offering the network is created from", - "name": "networkofferingname", + "description": "the owner of the network", + "name": "account", "type": "string" }, { - "description": "The vlan of the network. This parameter is visible to ROOT admins only", - "name": "vlan", + "description": "true if network supports specifying ip ranges, false otherwise", + "name": "specifyipranges", + "type": "boolean" + }, + { + "description": "name of the network offering the network is created from", + "name": "networkofferingname", "type": "string" }, { - "description": "the physical network id", - "name": "physicalnetworkid", + "description": "broadcast uri of the network. This parameter is visible to ROOT admins only", + "name": "broadcasturi", "type": "string" }, { @@ -4588,47 +4642,72 @@ "type": "date" }, { - "description": "true if network is default, false otherwise", - "name": "isdefault", + "description": "the name of the zone the network belongs to", + "name": "zonename", + "type": "string" + }, + { + "description": "the id of the network", + "name": "id", + "type": "string" + }, + { + "description": "list networks available for vm deployment", + "name": "canusefordeploy", "type": "boolean" }, { - "description": "Broadcast domain type of the network", - "name": "broadcastdomaintype", + "description": "The external id of the network", + "name": "externalid", "type": "string" }, { - "description": "the id of the network", - "name": "id", + "description": "The internet protocol of network offering", + "name": "internetprotocol", "type": "string" }, { - "description": "the network domain", - "name": "networkdomain", + "description": "the ID of the Network associated with this network", + "name": "associatednetworkid", "type": "string" }, { - "description": "the list of resource tags associated with network", - "name": "tags", - "response": [ - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, + "description": "true if network can span multiple zones", + "name": "strechedl2subnet", + "type": "boolean" + }, + { + "description": "the domain id of the network owner", + "name": "domainid", + "type": "string" + }, + { + "description": "the project name of the address", + "name": "project", + "type": "string" + }, + { + "description": "the network's netmask", + "name": "netmask", + "type": "string" + }, + { + "description": "related to what other network configuration", + "name": "related", + "type": "string" + }, + { + "description": "the list of resource tags associated with network", + "name": "tags", + "response": [ { - "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 account associated with the tag", + "name": "account", "type": "string" }, { @@ -4637,13 +4716,13 @@ "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": "customer associated with the tag", - "name": "customer", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { @@ -4652,33 +4731,63 @@ "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" } ], "type": "list" }, { - "description": "true network requires restart", - "name": "restartrequired", - "type": "boolean" + "description": "the details of the network", + "name": "details", + "type": "map" }, { - "description": "display text of the network offering the network is created from", - "name": "networkofferingdisplaytext", + "description": "network offering id the network is created from", + "name": "networkofferingid", "type": "string" }, { - "description": "related to what other network configuration", - "name": "related", + "description": "true if guest network default egress policy is allow; false if default egress policy is deny", + "name": "egressdefaultpolicy", + "type": "boolean" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the project id of the ipaddress", + "name": "projectid", "type": "string" }, + { + "description": "true if network is system, false otherwise", + "name": "issystem", + "type": "boolean" + }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, { "description": "the list of services", "name": "service", @@ -4692,6 +4801,16 @@ "name": "state", "type": "string" }, + { + "description": "the destination physical network", + "name": "destinationphysicalnetworkid", + "type": "string" + }, + { + "description": "the physical network this belongs to", + "name": "physicalnetworkid", + "type": "string" + }, { "description": "true if individual services can be enabled/disabled", "name": "canenableindividualservice", @@ -4702,21 +4821,11 @@ "name": "id", "type": "string" }, - { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", - "type": "string" - }, { "description": "the provider name", "name": "name", "type": "string" }, - { - "description": "the destination physical network", - "name": "destinationphysicalnetworkid", - "type": "string" - }, { "description": "services for this provider", "name": "servicelist", @@ -4725,11 +4834,6 @@ ], "type": "list" }, - { - "description": "the service name", - "name": "name", - "type": "string" - }, { "description": "the list of capabilities", "name": "capability", @@ -4739,158 +4843,176 @@ "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" + }, + { + "description": "the capability name", + "name": "name", + "type": "string" } ], "type": "list" + }, + { + "description": "the service name", + "name": "name", + "type": "string" } ], "type": "list" }, { - "description": "the project name of the address", - "name": "project", + "description": "the physical network id", + "name": "physicalnetworkid", "type": "string" }, { - "description": "zone id of the network", - "name": "zoneid", + "description": "the network CIDR of the guest network configured with IP reservation. It is the summation of CIDR and RESERVED_IP_RANGE", + "name": "networkcidr", "type": "string" }, - {}, - { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, { - "description": "the domain name of the network owner", - "name": "domain", + "description": "the ID of the Network associated with this private gateway", + "name": "associatednetworkid", "type": "string" }, { - "description": "state of the network", - "name": "state", - "type": "string" + "description": "The routes for the network to ease adding route in upstream router", + "name": "ip6routes", + "type": "set" }, { - "description": "the name of the network", - "name": "name", + "description": "the network's gateway", + "name": "gateway", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the domain id of the network owner", - "name": "domainid", + "description": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR", + "name": "cidr", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the network domain", + "name": "networkdomain", "type": "string" }, { - "description": "Name of the VPC to which this network belongs", - "name": "vpcname", - "type": "string" + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" }, { - "description": "the first DNS for the network", - "name": "dns1", - "type": "string" + "description": "true if users from subdomains can access the domain level network", + "name": "subdomainaccess", + "type": "boolean" + } + ] + }, + { + "description": "List dedicated zones.", + "isasync": false, + "name": "listDedicatedZones", + "params": [ + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" }, { - "description": "the network's netmask", - "name": "netmask", - "type": "string" + "description": "list dedicated zones by affinity group", + "length": 255, + "name": "affinitygroupid", + "related": "createAffinityGroup,listAffinityGroups", + "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": "the ID of the Zone", + "length": 255, + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": false, + "type": "uuid" }, { - "description": "acl type - access type to the network", - "name": "acltype", - "type": "string" + "description": "the ID of the domain associated with the zone", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", + "required": false, + "type": "uuid" }, { - "description": "The external id of the network", - "name": "externalid", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "VPC the network belongs to", - "name": "vpcid", + "description": "the name of the account associated with the zone. Must be used with domainId.", + "length": 255, + "name": "account", + "required": false, "type": "string" }, { - "description": "list networks that are persistent", - "name": "ispersistent", - "type": "boolean" - }, + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + } + ], + "related": "dedicateZone", + "response": [ { - "description": "the type of the network", - "name": "type", + "description": "the ID of the dedicated resource", + "name": "id", "type": "string" }, { - "description": "ACL Id associated with the VPC network", - "name": "aclid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "true if network supports specifying ip ranges, false otherwise", - "name": "specifyipranges", - "type": "boolean" - }, - { - "description": "If the network has redundant routers enabled", - "name": "redundantrouter", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "network offering id the network is created from", - "name": "networkofferingid", + "description": "the domain ID to which the Zone is dedicated", + "name": "domainid", "type": "string" }, { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "the Account Id to which the Zone is dedicated", + "name": "accountid", "type": "string" }, { - "description": "the traffic type of the network", - "name": "traffictype", + "description": "the Dedication Affinity Group ID of the zone", + "name": "affinitygroupid", "type": "string" }, { - "description": "the second DNS for the network", - "name": "dns2", + "description": "the ID of the Zone", + "name": "zoneid", "type": "string" }, + {}, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" - }, - { - "description": "broadcast uri of the network. This parameter is visible to ROOT admins only", - "name": "broadcasturi", + "description": "the Name of the Zone", + "name": "zonename", "type": "string" - } + }, + {} ] }, { @@ -4909,19 +5031,13 @@ "related": "", "response": [ { - "description": "the ID of the storage pool", - "name": "id", + "description": "the state of the storage pool", + "name": "state", "type": "string" }, - {}, - { - "description": "available iops of the pool", - "name": "maxiops", - "type": "long" - }, { - "description": "controller of the pool", - "name": "controllerid", + "description": "the ID of the storage pool", + "name": "id", "type": "string" }, { @@ -4934,16 +5050,17 @@ "name": "gateway", "type": "string" }, - { - "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 current available space of the pool", + "name": "size", + "type": "long" + }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", @@ -4951,31 +5068,67 @@ }, {}, { - "description": "the state of the storage pool", - "name": "state", + "description": "available iops of the pool", + "name": "maxiops", + "type": "long" + }, + { + "description": "controller of the pool", + "name": "controllerid", "type": "string" } ] }, { - "description": "Updates a management network IP range. Only allowed when no IPs are allocated.", - "isasync": true, - "name": "updatePodManagementNetworkIpRange", + "description": "Releases an IP address from the account.", + "isasync": false, + "name": "releaseIpAddress", "params": [ { - "description": "The current starting IP address.", + "description": "the ID of the public IP address to release", "length": 255, - "name": "currentstartip", - "related": "listPods,updatePod,createManagementNetworkIpRange", + "name": "id", + "related": "associateIpAddress,reserveIpAddress,listPublicIpAddresses,updateIpAddress,associateIpAddress,listPublicIpAddresses", "required": true, + "type": "uuid" + } + ], + "response": [ + {}, + {}, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "The current ending IP address.", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + } + ], + "since": "4.17" + }, + { + "description": "Updates a management network IP range. Only allowed when no IPs are allocated.", + "isasync": true, + "name": "updatePodManagementNetworkIpRange", + "params": [ + { + "description": "The new starting IP address.", "length": 255, - "name": "currentendip", - "related": "listPods,updatePod,createManagementNetworkIpRange", - "required": true, + "name": "newstartip", + "required": false, "type": "string" }, { @@ -4985,6 +5138,14 @@ "required": false, "type": "string" }, + { + "description": "The current starting IP address.", + "length": 255, + "name": "currentstartip", + "related": "listPods,updatePod,createManagementNetworkIpRange", + "required": true, + "type": "string" + }, { "description": "UUID of POD, where the IP range belongs to.", "length": 255, @@ -4994,24 +5155,26 @@ "type": "uuid" }, { - "description": "The new starting IP address.", + "description": "The current ending IP address.", "length": 255, - "name": "newstartip", - "required": false, + "name": "currentendip", + "related": "listPods,updatePod,createManagementNetworkIpRange", + "required": true, "type": "string" } ], "response": [ { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, + {}, { "description": "true if operation is executed successfully", "name": "success", @@ -5022,8 +5185,7 @@ "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - }, - {} + } ], "since": "4.16.0.0" }, @@ -5033,36 +5195,36 @@ "name": "updateFirewallRule", "params": [ { - "description": "an optional field, whether to the display the rule to the end user or not", + "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", "length": 255, - "name": "fordisplay", + "name": "customid", "required": false, "since": "4.4", - "type": "boolean" + "type": "string" }, { "description": "the ID of the firewall rule", "length": 255, "name": "id", - "related": "createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules", + "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", + "description": "an optional field, whether to the display the rule to the end user or not", "length": 255, - "name": "customid", + "name": "fordisplay", "required": false, "since": "4.4", - "type": "string" + "type": "boolean" } ], "related": "createEgressFirewallRule,createFirewallRule,listEgressFirewallRules,listFirewallRules,updateEgressFirewallRule", "response": [ { - "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": "type of the icmp message being sent", @@ -5070,53 +5232,47 @@ "type": "integer" }, { - "description": "the ending port of firewall rule's port range", - "name": "endport", - "type": "integer" + "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", + "type": "string" }, - {}, { - "description": "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 protocol of the firewall rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the public ip address for the firewall rule", - "name": "ipaddress", + "description": "the ID of the firewall rule", + "name": "id", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "is rule 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": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "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" }, { @@ -5125,23 +5281,23 @@ "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { @@ -5153,46 +5309,57 @@ "type": "list" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "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", - "type": "string" + "description": "error code for this icmp message", + "name": "icmpcode", + "type": "integer" }, { - "description": "the starting port of firewall rule's port range", - "name": "startport", + "description": "the ending port of firewall rule's port range", + "name": "endport", "type": "integer" }, - {}, { - "description": "the state of the rule", - "name": "state", + "description": "the traffic type for the firewall rule", + "name": "traffictype", "type": "string" }, { - "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", + "description": "the 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 starting port of firewall rule's port range", + "name": "startport", + "type": "integer" }, { - "description": "the cidr list to forward traffic to. Multiple entries are separated by a single comma character (,).", - "name": "destcidrlist", + "description": "the public ip address id for the firewall rule", + "name": "ipaddressid", "type": "string" }, { - "description": "the network id of the firewall rule", - "name": "networkid", + "description": "the state of the rule", + "name": "state", "type": "string" - } + }, + { + "description": "the protocol of the firewall rule", + "name": "protocol", + "type": "string" + }, + {}, + { + "description": "the cidr list to forward traffic to. Multiple entries are separated by a single comma character (,).", + "name": "destcidrlist", + "type": "string" + }, + {} ], "since": "4.4" }, @@ -5204,9 +5371,9 @@ "related": "", "response": [ { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "is quota service enabled", + "name": "isenabled", + "type": "boolean" }, {}, { @@ -5214,12 +5381,12 @@ "name": "jobstatus", "type": "integer" }, - {}, { - "description": "is quota service enabled", - "name": "isenabled", - "type": "boolean" - } + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + {} ], "since": "4.7.0" }, @@ -5228,13 +5395,6 @@ "isasync": false, "name": "listSrxFirewalls", "params": [ - { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, { "description": "", "length": 255, @@ -5249,6 +5409,14 @@ "required": false, "type": "string" }, + { + "description": "SRX firewall device ID", + "length": 255, + "name": "fwdeviceid", + "related": "addSrxFirewall,configureSrxFirewall,listSrxFirewalls", + "required": false, + "type": "uuid" + }, { "description": "the Physical Network ID", "length": 255, @@ -5258,59 +5426,55 @@ "type": "uuid" }, { - "description": "SRX firewall device ID", + "description": "", "length": 255, - "name": "fwdeviceid", - "related": "addSrxFirewall,configureSrxFirewall,listSrxFirewalls", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" } ], "related": "addSrxFirewall,configureSrxFirewall", "response": [ + {}, { "description": "the management IP address of the external firewall", "name": "ipaddress", "type": "string" }, { - "description": "device capacity", - "name": "fwdevicecapacity", - "type": "long" - }, - { - "description": "the timeout (in seconds) for requests to the external firewall", - "name": "timeout", + "description": "the public interface of the external firewall", + "name": "publicinterface", "type": "string" }, { - "description": "name of the provider", - "name": "provider", + "description": "the usage interface of the external firewall", + "name": "usageinterface", "type": "string" }, { - "description": "the private security zone of the external firewall", - "name": "privatezone", + "description": "the private interface of the external firewall", + "name": "privateinterface", "type": "string" }, { - "description": "the usage interface of the external firewall", - "name": "usageinterface", - "type": "string" + "description": "device capacity", + "name": "fwdevicecapacity", + "type": "long" }, { - "description": "device id of the SRX firewall", - "name": "fwdeviceid", + "description": "name of the provider", + "name": "provider", "type": "string" }, { - "description": "the username that's used to log in to the external firewall", - "name": "username", + "description": "the public security zone of the external firewall", + "name": "publiczone", "type": "string" }, + {}, { - "description": "the zone ID of the external firewall", - "name": "zoneid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -5319,47 +5483,50 @@ "type": "string" }, { - "description": "the public interface of the external firewall", - "name": "publicinterface", + "description": "the physical network to which this SRX firewall belongs to", + "name": "physicalnetworkid", "type": "string" }, { - "description": "the public security zone of the external firewall", - "name": "publiczone", + "description": "the username that's used to log in to the external firewall", + "name": "username", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "device state", + "name": "fwdevicestate", + "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the timeout (in seconds) for requests to the external firewall", + "name": "timeout", "type": "string" }, { - "description": "device state", - "name": "fwdevicestate", + "description": "the zone ID of the external firewall", + "name": "zoneid", "type": "string" }, { - "description": "device name", - "name": "fwdevicename", + "description": "device id of the SRX firewall", + "name": "fwdeviceid", "type": "string" }, { - "description": "the physical network to which this SRX firewall belongs to", - "name": "physicalnetworkid", + "description": "device name", + "name": "fwdevicename", "type": "string" }, { - "description": "the private interface of the external firewall", - "name": "privateinterface", + "description": "the private security zone of the external firewall", + "name": "privatezone", "type": "string" }, - {} + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } ] }, { @@ -5367,13 +5534,6 @@ "isasync": true, "name": "deleteAccountFromProject", "params": [ - { - "description": "name of the account to be removed from the project", - "length": 255, - "name": "account", - "required": true, - "type": "string" - }, { "description": "ID of the project to remove the account from", "length": 255, @@ -5381,26 +5541,33 @@ "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", "required": true, "type": "uuid" + }, + { + "description": "name of the account to be removed from the project", + "length": 255, + "name": "account", + "required": true, + "type": "string" } ], "response": [ + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, - {}, - {}, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", @@ -5426,6 +5593,11 @@ "related": "", "response": [ {}, + { + "description": "Hypervisor name", + "name": "name", + "type": "string" + }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", @@ -5436,12 +5608,7 @@ "name": "jobstatus", "type": "integer" }, - {}, - { - "description": "Hypervisor name", - "name": "name", - "type": "string" - } + {} ] }, { @@ -5474,46 +5641,209 @@ ], "related": "listOsTypes,addGuestOs", "response": [ + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the name/description of the OS type", + "name": "description", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "is the guest OS user defined", "name": "isuserdefined", "type": "boolean" }, - {}, { "description": "the ID of the OS category", "name": "oscategoryid", "type": "string" }, {}, + { + "description": "the ID of the OS type", + "name": "id", + "type": "string" + }, + {} + ], + "since": "4.4.0" + }, + { + "description": "Lists all guest vlans", + "isasync": false, + "name": "listGuestVlans", + "params": [ + { + "description": "list guest vlan by vnet", + "length": 255, + "name": "vnet", + "required": false, + "type": "string" + }, + { + "description": "list guest vlan by id", + "length": 255, + "name": "id", + "required": false, + "type": "long" + }, + { + "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 guest vlan by physical network", + "length": 255, + "name": "physicalnetworkid", + "related": "createPhysicalNetwork,listPhysicalNetworks,updatePhysicalNetwork", + "required": false, + "type": "uuid" + }, + { + "description": "limits search results to allocated guest vlan. false by default.", + "length": 255, + "name": "allocatedonly", + "required": false, + "type": "boolean" + }, + { + "description": "list guest vlan by zone", + "length": 255, + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": false, + "type": "uuid" + } + ], + "related": "", + "response": [ + { + "description": "the project id of the guest VLAN range", + "name": "projectid", + "type": "string" + }, + { + "description": "the list of networks who use this guest VLAN", + "name": "network", + "type": "list" + }, + { + "description": "date the guest VLAN was taken", + "name": "taken", + "type": "date" + }, + { + "description": "the guest VLAN", + "name": "vlan", + "type": "string" + }, + { + "description": "the account of the guest VLAN range", + "name": "account", + "type": "string" + }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, + {}, + {}, { - "description": "the ID of the OS type", - "name": "id", + "description": "the domain name of the guest VLAN range", + "name": "domain", "type": "string" }, { - "description": "the name/description of the OS type", - "name": "description", + "description": "the physical network name of the guest VLAN range", + "name": "physicalnetworkname", + "type": "string" + }, + { + "description": "true if the guest VLAN is dedicated to the account", + "name": "isdedicated", + "type": "boolean" + }, + { + "description": "the physical network ID of the guest VLAN range", + "name": "physicalnetworkid", "type": "string" }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" + }, + { + "description": "the allocation state of the guest VLAN", + "name": "allocationstate", + "type": "string" + }, + { + "description": "the domain ID of the guest VLAN range", + "name": "domainid", + "type": "string" + }, + { + "description": "the project name of the guest VLAN range", + "name": "project", + "type": "string" + }, + { + "description": "the zone ID of the guest VLAN range", + "name": "zoneid", + "type": "string" + }, + { + "description": "the guest VLAN id", + "name": "id", + "type": "long" + }, + { + "description": "the zone name of the guest VLAN range", + "name": "zonename", + "type": "string" } ], - "since": "4.4.0" + "since": "4.17.0" }, { "description": "Updates resource limits for an account or domain.", "isasync": false, "name": "updateResourceLimit", "params": [ + { + "description": " Maximum resource limit.", + "length": 255, + "name": "max", + "required": false, + "type": "long" + }, { "description": "Update resource limits for all accounts in specified domain. If used with the account parameter, updates resource limits for a specified account in specified domain.", "length": 255, @@ -5529,20 +5859,6 @@ "required": false, "type": "string" }, - { - "description": "Type of resource to update. Values are 0, 1, 2, 3, 4, 6, 7, 8, 9, 10 and 11. 0 - Instance. Number of instances a user can create. 1 - IP. Number of public IP addresses a user can own. 2 - Volume. Number of disk volumes a user can create. 3 - Snapshot. Number of snapshots a user can create. 4 - Template. Number of templates that a user can register/create. 6 - Network. Number of guest network a user can create. 7 - VPC. Number of VPC a user can create. 8 - CPU. Total number of CPU cores a user can use. 9 - Memory. Total Memory (in MB) a user can use. 10 - PrimaryStorage. Total primary storage space (in GiB) a user can use. 11 - SecondaryStorage. Total secondary storage space (in GiB) a user can use. ", - "length": 255, - "name": "resourcetype", - "required": true, - "type": "integer" - }, - { - "description": " Maximum resource limit.", - "length": 255, - "name": "max", - "required": false, - "type": "long" - }, { "description": "Update resource limits for project", "length": 255, @@ -5550,18 +5866,25 @@ "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 maximum number of the resource. A -1 means the resource currently has no limit.", - "name": "max", - "type": "long" + "description": "the domain name of the resource limit", + "name": "domain", + "type": "string" }, { - "description": "the project name of the resource limit", - "name": "project", + "description": "resource type name. Values include user_vm, public_ip, volume, snapshot, template, project, network, vpc, cpu, memory, primary_storage, secondary_storage.", + "name": "resourcetypename", "type": "string" }, { @@ -5569,22 +5892,23 @@ "name": "jobstatus", "type": "integer" }, + {}, { - "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": "resource type name. Values include user_vm, public_ip, volume, snapshot, template, project, network, vpc, cpu, memory, primary_storage, secondary_storage.", - "name": "resourcetypename", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the domain ID of the resource limit", + "name": "domainid", "type": "string" }, + {}, { "description": "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", @@ -5596,14 +5920,13 @@ "type": "string" }, { - "description": "the domain ID of the resource limit", - "name": "domainid", + "description": "the account of the resource limit", + "name": "account", "type": "string" }, - {}, { - "description": "the account of the resource limit", - "name": "account", + "description": "the project name of the resource limit", + "name": "project", "type": "string" } ] @@ -5653,41 +5976,49 @@ "name": "listHostsMetrics", "params": [ { - "description": "the state of the host", + "description": "the Zone ID for the host", "length": 255, - "name": "state", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "list hosts by resource state. Resource state represents current state determined by admin of host, value can be one of [Enabled, Disabled, Unmanaged, PrepareForMaintenance, ErrorInMaintenance, Maintenance, Error]", + "description": "the name of the host", "length": 255, - "name": "resourcestate", + "name": "name", "required": false, "type": "string" }, { - "description": "list hosts for which out-of-band management is enabled", + "description": "the host type", "length": 255, - "name": "outofbandmanagementenabled", + "name": "type", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "the host type", + "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": "type", + "name": "resourcestate", "required": false, "type": "string" }, { - "description": "the id of the host", + "description": "lists hosts in the same cluster as this VM and flag hosts with enough CPU/RAm to host this VM", "length": 255, - "name": "id", - "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost,updateHost,addBaremetalHost,listExternalLoadBalancers", + "name": "virtualmachineid", + "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVmNicIp,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance", "required": false, "type": "uuid" }, + { + "description": "list hosts for which out-of-band management is enabled", + "length": 255, + "name": "outofbandmanagementenabled", + "required": false, + "type": "boolean" + }, { "description": "the Pod ID for the host", "length": 255, @@ -5697,38 +6028,39 @@ "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": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost,updateHost", "required": false, "type": "uuid" }, { - "description": "List by keyword", + "description": "lists hosts existing in particular cluster", "length": 255, - "name": "keyword", + "name": "clusterid", + "related": "addCluster,listClusters,updateCluster", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "the name 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": "name", + "name": "details", "required": false, - "type": "string" + "type": "list" }, { - "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": "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" }, @@ -5740,34 +6072,25 @@ "type": "integer" }, { - "description": "lists hosts in the same cluster as this VM and flag hosts with enough CPU/RAm to host this VM", - "length": 255, - "name": "virtualmachineid", - "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVmNicIp,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance", - "required": false, - "type": "uuid" - }, - { - "description": "comma separated list of host details requested, value can be a list of [ min, all, capacity, events, stats]", + "description": "the state of the host", "length": 255, - "name": "details", + "name": "state", "required": false, - "type": "list" + "type": "string" }, { - "description": "lists hosts existing in particular cluster", + "description": "hypervisor type of host: XenServer,KVM,VMware,Hyperv,BareMetal,Simulator", "length": 255, - "name": "clusterid", - "related": "addCluster,listClusters,updateCluster", + "name": "hypervisor", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "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": "", @@ -5780,104 +6103,119 @@ "related": "", "response": [ { - "description": "the amount of the host's CPU currently allocated", - "name": "cpuallocated", - "type": "string" + "description": "cpu usage disable threshold exceeded", + "name": "cpudisablethreshold", + "type": "boolean" }, { - "description": "the IP address of the host", - "name": "ipaddress", - "type": "string" + "description": "the amount of the host's memory currently allocated", + "name": "memoryallocated", + "type": "long" }, { - "description": "memory usage notification threshold exceeded", - "name": "memorythreshold", - "type": "boolean" + "description": "the amount of the host's memory currently allocated in bytes", + "name": "memoryallocatedbytes", + "type": "long" }, { - "description": "the last annotation set on this host by an admin", - "name": "annotation", - "type": "string" + "description": "the date and time the host was created", + "name": "created", + "type": "date" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the amount of the host's memory currently used", + "name": "memoryused", + "type": "long" }, { - "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", - "name": "cpuallocatedwithoverprovisioning", + "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor", + "name": "cpuwithoverprovisioning", "type": "string" }, { - "description": "true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise", - "name": "hasenoughcapacity", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "the ID of the host", - "name": "id", + "description": "the Pod name of the host", + "name": "podname", "type": "string" }, { - "description": "the outgoing network traffic on the host", - "name": "networkkbswrite", - "type": "long" + "description": "the resource state of the host", + "name": "resourcestate", + "type": "string" }, { - "description": "the management server ID of the host", - "name": "managementserverid", + "description": "the amount of the host's CPU currently allocated in percentage", + "name": "cpuallocatedpercentage", "type": "string" }, { - "description": "the total memory allocated in GiB", - "name": "memoryallocatedgb", - "type": "string" + "description": "the last time this host was annotated", + "name": "lastannotated", + "type": "date" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "true if the host has capability to support UEFI boot", + "name": "ueficapability", "type": "boolean" }, { - "description": "the amount of the host's memory currently allocated in bytes", - "name": "memoryallocatedbytes", - "type": "long" + "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", + "description": "the number of CPU sockets on the host", + "name": "cpusockets", + "type": "integer" + }, + { + "description": "cpu allocated disable threshold exceeded", + "name": "cpuallocateddisablethreshold", "type": "boolean" }, { - "description": "the CPU number of the host", - "name": "cpunumber", - "type": "integer" + "description": "comma-separated list of tags for the host", + "name": "hosttags", + "type": "string" }, { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", - "type": "long" + "description": "the date and time the host was last pinged", + "name": "lastpinged", + "type": "date" }, { - "description": "the cluster ID of the host", - "name": "clusterid", + "description": "the Zone name of the host", + "name": "zonename", "type": "string" }, { - "description": "the name of the host", - "name": "name", + "description": "the cluster type of the cluster that host belongs to", + "name": "clustertype", + "type": "string" + }, + { + "description": "the amount of the host's CPU currently used", + "name": "cpuused", "type": "string" }, + { + "description": "true if this host is suitable(has enough capacity and satisfies all conditions like hosttags, max guests vm limit etc) to migrate a VM to it , false otherwise", + "name": "suitableformigration", + "type": "boolean" + }, { "description": "the amount of the host's CPU currently allocated in MHz", "name": "cpuallocatedvalue", "type": "long" }, { - "description": "events available for the host", - "name": "events", - "type": "string" + "description": "the outgoing network traffic on the host", + "name": "networkkbswrite", + "type": "long" }, { "description": "the average cpu load the last minute", @@ -5885,330 +6223,300 @@ "type": "double" }, { - "description": "out-of-band management power state", - "name": "powerstate", - "type": "powerstate" - }, - { - "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise", - "name": "hahost", - "type": "boolean" - }, - { - "description": "the 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 admin that annotated this host", - "name": "username", - "type": "string" + "description": "the incoming network traffic on the host", + "name": "networkkbsread", + "type": "long" }, { - "description": "cpu usage notification threshold exceeded", - "name": "cputhreshold", + "description": "memory allocated notification threshold exceeded", + "name": "memoryallocatedthreshold", "type": "boolean" }, { - "description": "the Pod ID of the host", - "name": "podid", + "description": "network write in GiB", + "name": "networkwrite", "type": "string" }, { - "description": "the host HA information information", - "name": "hostha", - "type": "hostharesponse" + "description": "the date and time the host was removed", + "name": "removed", + "type": "date" }, { - "description": "the OS category name of the host", - "name": "oscategoryname", + "description": "the host version", + "name": "version", "type": "string" }, { - "description": "the CPU speed of the host", - "name": "cpuspeed", - "type": "long" - }, - { - "description": "true if the host is disconnected. False otherwise.", - "name": "disconnected", - "type": "date" + "description": "the cpu average load on the host", + "name": "cpuloadaverage", + "type": "double" }, { - "description": "the amount of the host's memory after applying the mem.overprovisioning.factor", - "name": "memorywithoverprovisioning", + "description": "the ID of the host", + "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 no. of vgpu per gpu card (pgpu)", - "name": "maxvgpuperpgpu", - "type": "long" - }, - { - "description": "Video RAM for this vGPU type", - "name": "videoram", - "type": "long" - }, - { - "description": "Maximum Y resolution per display", - "name": "maxresolutiony", - "type": "long" - }, - { - "description": "Maximum 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" - } - ], - "type": "list" + "description": "cpu allocated notification threshold exceeded", + "name": "cpuallocatedthreshold", + "type": "boolean" }, { - "description": "the total cpu allocated in Ghz", - "name": "cpuallocatedghz", + "description": "capabilities of the host", + "name": "capabilities", "type": "string" }, { - "description": "the resource state of the host", - "name": "resourcestate", + "description": "the name of the host", + "name": "name", "type": "string" }, { - "description": "the total cpu used in Ghz", - "name": "cpuusedghz", + "description": "the IP address of the host", + "name": "ipaddress", "type": "string" }, { - "description": "instances on the host", - "name": "instances", + "description": "the admin that annotated this host", + "name": "username", "type": "string" }, { - "description": "the amount of the host's memory currently used", - "name": "memoryused", - "type": "long" - }, - { - "description": "the cpu average load on the host", - "name": "cpuloadaverage", - "type": "double" + "description": "the hypervisor version", + "name": "hypervisorversion", + "type": "string" }, { - "description": "the total disk size of the host", - "name": "disksizetotal", - "type": "long" + "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise", + "name": "hahost", + "type": "boolean" }, { - "description": "the total memory used in GiB", - "name": "memoryusedgb", + "description": "network read in GiB", + "name": "networkread", "type": "string" }, { - "description": "memory usage disable threshold exceeded", - "name": "memorydisablethreshold", + "description": "memory allocated disable threshold exceeded", + "name": "memoryallocateddisablethreshold", "type": "boolean" }, { - "description": "the amount of the host's memory currently allocated in percentage", - "name": "memoryallocatedpercentage", + "description": "the total memory capacity in GiB", + "name": "memorytotalgb", "type": "string" }, { - "description": "the hypervisor version", - "name": "hypervisorversion", + "description": "the cluster ID of the host", + "name": "clusterid", "type": "string" }, { - "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", - "name": "memorytotal", - "type": "long" + "description": "the state of the host", + "name": "state", + "type": "status" }, { - "description": "the host hypervisor", - "name": "hypervisor", - "type": "hypervisortype" + "description": "the Pod ID of the host", + "name": "podid", + "type": "string" }, { - "description": "Host details in key/value pairs.", - "name": "details", - "type": "map" + "description": "instances on the host", + "name": "instances", + "type": "string" }, { - "description": "the host out-of-band management information", - "name": "outofbandmanagement", - "type": "outofbandmanagementresponse" + "description": "out-of-band management power state", + "name": "powerstate", + "type": "powerstate" }, { - "description": "the date and time the host was created", - "name": "created", - "type": "date" + "description": "the Zone ID of the host", + "name": "zoneid", + "type": "string" }, { - "description": "cpu usage disable threshold exceeded", - "name": "cpudisablethreshold", + "description": "true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise", + "name": "hasenoughcapacity", "type": "boolean" }, { - "description": "the amount of the host's CPU currently used", - "name": "cpuused", - "type": "string" - }, - { - "description": "the Pod name of the host", - "name": "podname", - "type": "string" + "description": "memory usage notification threshold exceeded", + "name": "memorythreshold", + "type": "boolean" }, { - "description": "the total cpu capacity in Ghz", - "name": "cputotalghz", + "description": "the last annotation set on this host by an admin", + "name": "annotation", "type": "string" }, { - "description": "network write in GiB", - "name": "networkwrite", + "description": "the cluster name of the host", + "name": "clustername", "type": "string" }, { - "description": "the number of CPU sockets on the host", - "name": "cpusockets", - "type": "integer" + "description": "memory usage disable threshold exceeded", + "name": "memorydisablethreshold", + "type": "boolean" }, { - "description": "the host version", - "name": "version", + "description": "the amount of the host's memory currently allocated in percentage", + "name": "memoryallocatedpercentage", "type": "string" }, { - "description": "the date and time the host was last pinged", - "name": "lastpinged", - "type": "date" + "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", + "name": "memorytotal", + "type": "long" }, { - "description": "memory allocated disable threshold exceeded", - "name": "memoryallocateddisablethreshold", + "description": "cpu usage notification threshold exceeded", + "name": "cputhreshold", "type": "boolean" }, { - "description": "the last time this host was annotated", - "name": "lastannotated", - "type": "date" - }, - { - "description": "the state of the host", - "name": "state", - "type": "status" + "description": "the total memory allocated in GiB", + "name": "memoryallocatedgb", + "type": "string" }, + {}, { - "description": "cpu allocated disable threshold exceeded", - "name": "cpuallocateddisablethreshold", - "type": "boolean" + "description": "the host HA information information", + "name": "hostha", + "type": "hostharesponse" }, { - "description": "the total memory capacity in GiB", - "name": "memorytotalgb", - "type": "string" + "description": "GPU cards present in the host", + "name": "gpugroup", + "response": [ + { + "description": "the list of enabled vGPUs", + "name": "vgpu", + "response": [ + { + "description": "Model Name of vGPU", + "name": "vgputype", + "type": "string" + }, + { + "description": "Maximum displays per user", + "name": "maxheads", + "type": "long" + }, + { + "description": "Maximum X resolution per display", + "name": "maxresolutionx", + "type": "long" + }, + { + "description": "Maximum no. of vgpu per gpu card (pgpu)", + "name": "maxvgpuperpgpu", + "type": "long" + }, + { + "description": "Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type", + "name": "remainingcapacity", + "type": "long" + }, + { + "description": "Video RAM for this vGPU type", + "name": "videoram", + "type": "long" + }, + { + "description": "Maximum 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" + }, + { + "description": "GPU cards present in the host", + "name": "gpugroupname", + "type": "string" + } + ], + "type": "list" }, { - "description": "the cluster type of the cluster that host belongs to", - "name": "clustertype", - "type": "string" + "description": "the CPU number of the host", + "name": "cpunumber", + "type": "integer" }, + {}, { - "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor", - "name": "cpuwithoverprovisioning", + "description": "the amount of the host's memory after applying the mem.overprovisioning.factor", + "name": "memorywithoverprovisioning", "type": "string" }, { - "description": "capabilities of the host", - "name": "capabilities", + "description": "the OS category name of the host", + "name": "oscategoryname", "type": "string" }, { - "description": "comma-separated list of tags for the host", - "name": "hosttags", + "description": "the OS category ID of the host", + "name": "oscategoryid", "type": "string" }, - {}, - {}, { - "description": "memory allocated notification threshold exceeded", - "name": "memoryallocatedthreshold", - "type": "boolean" + "description": "the CPU speed of the host", + "name": "cpuspeed", + "type": "long" }, { - "description": "the Zone name of the host", - "name": "zonename", + "description": "the management server ID of the host", + "name": "managementserverid", "type": "string" }, { - "description": "true if this host is suitable(has enough capacity and satisfies all conditions like hosttags, max guests vm limit etc) to migrate a VM to it , false otherwise", - "name": "suitableformigration", + "description": "true if local storage is active, false otherwise", + "name": "islocalstorageactive", "type": "boolean" }, { - "description": "cpu allocated notification threshold exceeded", - "name": "cpuallocatedthreshold", - "type": "boolean" + "description": "the host's currently allocated disk size", + "name": "disksizeallocated", + "type": "long" }, { - "description": "the incoming network traffic on the host", - "name": "networkkbsread", - "type": "long" + "description": "Host details in key/value pairs.", + "name": "details", + "type": "map" }, { - "description": "the cluster name of the host", - "name": "clustername", + "description": "the total cpu used in Ghz", + "name": "cpuusedghz", "type": "string" }, { - "description": "the amount of the host's memory currently allocated", - "name": "memoryallocated", - "type": "long" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the OS category ID of the host", - "name": "oscategoryid", + "description": "the total memory used in GiB", + "name": "memoryusedgb", "type": "string" }, { - "description": "true if local storage is active, false otherwise", - "name": "islocalstorageactive", - "type": "boolean" + "description": "the total cpu capacity in Ghz", + "name": "cputotalghz", + "type": "string" }, { "description": "the host type", @@ -6216,24 +6524,39 @@ "type": "type" }, { - "description": "the date and time the host was removed", - "name": "removed", - "type": "date" + "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", + "name": "cpuallocatedwithoverprovisioning", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the total cpu allocated in Ghz", + "name": "cpuallocatedghz", "type": "string" }, { - "description": "network read in GiB", - "name": "networkread", + "description": "events available for the host", + "name": "events", "type": "string" }, { - "description": "the amount of the host's CPU currently allocated in percentage", - "name": "cpuallocatedpercentage", + "description": "the total disk size of the host", + "name": "disksizetotal", + "type": "long" + }, + { + "description": "the amount of the host's CPU currently allocated", + "name": "cpuallocated", "type": "string" + }, + { + "description": "true if the host is disconnected. False otherwise.", + "name": "disconnected", + "type": "date" + }, + { + "description": "the host hypervisor", + "name": "hypervisor", + "type": "hypervisortype" } ], "since": "4.9.3" @@ -6254,27 +6577,27 @@ ], "response": [ { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, - {}, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" }, { - "description": "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" - } + }, + {} ] }, { @@ -6283,46 +6606,54 @@ "name": "listAffinityGroups", "params": [ { - "description": "lists affinity groups by name", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "name", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", "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": "lists affinity groups by name", "length": 255, - "name": "isrecursive", + "name": "name", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "", + "description": "lists affinity groups by virtual machine ID", "length": 255, - "name": "page", + "name": "virtualmachineid", + "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVmNicIp,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "list objects by project", + "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": "If set to false, list only 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": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller 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 the affinity group by the ID provided", + "description": "", "length": 255, - "name": "id", - "related": "createAffinityGroup,listAffinityGroups", + "name": "page", + "required": false, + "type": "integer" + }, + { + "description": "list objects by project; if projectid=-1 lists All VMs", + "length": 255, + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", "required": false, "type": "uuid" }, @@ -6334,12 +6665,11 @@ "type": "string" }, { - "description": "lists affinity groups by 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,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVmNicIp,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance", + "name": "isrecursive", "required": false, - "type": "uuid" + "type": "boolean" }, { "description": "lists affinity groups by type", @@ -6356,56 +6686,50 @@ "type": "integer" }, { - "description": "list only resources belonging to the domain specified", + "description": "list the affinity group by the ID provided", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", + "name": "id", + "related": "createAffinityGroup,listAffinityGroups", "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": "createAffinityGroup", "response": [ { - "description": "the domain ID of the affinity group", - "name": "domainid", + "description": "the ID of the affinity group", + "name": "id", "type": "string" }, { - "description": "the description of the affinity group", - "name": "description", - "type": "string" + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" }, { - "description": "the type of the affinity group", - "name": "type", + "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 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 account owning the affinity group", + "name": "account", "type": "string" }, { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" + "description": "the type of the affinity group", + "name": "type", + "type": "string" }, { - "description": "the ID of the affinity group", - "name": "id", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -6414,18 +6738,14 @@ "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the project ID of the affinity group", + "name": "projectid", "type": "string" }, + {}, { - "description": "the account owning the affinity group", - "name": "account", + "description": "the name of the affinity group", + "name": "name", "type": "string" }, { @@ -6433,8 +6753,11 @@ "name": "domain", "type": "string" }, - {}, - {} + { + "description": "the description of the affinity group", + "name": "description", + "type": "string" + } ] }, { @@ -6443,19 +6766,18 @@ "name": "registerSSHKeyPair", "params": [ { - "description": "Public key material of the keypair", - "length": 5120, - "name": "publickey", + "description": "Name of the keypair", + "length": 255, + "name": "name", "required": true, "type": "string" }, { - "description": "an optional domainId for the ssh key. If the account parameter is used, domainId must also be used.", + "description": "an optional account for the ssh key. Must be used with domainId.", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", + "name": "account", "required": false, - "type": "uuid" + "type": "string" }, { "description": "an optional project for the ssh key", @@ -6466,31 +6788,27 @@ "type": "uuid" }, { - "description": "Name of the keypair", + "description": "an optional domainId for the ssh key. If the account parameter is used, domainId must also be used.", "length": 255, - "name": "name", - "required": true, - "type": "string" + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", + "required": false, + "type": "uuid" }, { - "description": "an optional account for the ssh key. Must be used with domainId.", - "length": 255, - "name": "account", - "required": false, + "description": "Public key material of the keypair", + "length": 5120, + "name": "publickey", + "required": true, "type": "string" } ], "related": "listSSHKeyPairs", "response": [ { - "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": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { "description": "the owner of the keypair", @@ -6504,8 +6822,8 @@ }, {}, { - "description": "Fingerprint of the public key", - "name": "fingerprint", + "description": "the domain name of the keypair owner", + "name": "domain", "type": "string" }, { @@ -6513,20 +6831,25 @@ "name": "jobid", "type": "string" }, - {}, { - "description": "ID of the ssh keypair", - "name": "id", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the domain id of the keypair owner", + "name": "domainid", "type": "string" }, + {}, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "Fingerprint of the public key", + "name": "fingerprint", + "type": "string" }, { - "description": "the domain id of the keypair owner", - "name": "domainid", + "description": "ID of the ssh keypair", + "name": "id", "type": "string" } ] @@ -6540,19 +6863,17 @@ "description": "public ip address id of the vpn server", "length": 255, "name": "publicipid", - "related": "associateIpAddress,listPublicIpAddresses,updateIpAddress,associateIpAddress,listPublicIpAddresses", + "related": "associateIpAddress,reserveIpAddress,listPublicIpAddresses,updateIpAddress,associateIpAddress,listPublicIpAddresses", "required": true, "type": "uuid" } ], "response": [ - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", @@ -6563,6 +6884,8 @@ "name": "displaytext", "type": "string" }, + {}, + {}, { "description": "true if operation is executed successfully", "name": "success", @@ -6576,33 +6899,34 @@ "name": "startRollingMaintenance", "params": [ { - "description": "the IDs of the clusters to start maintenance on", + "description": "the IDs of the zones to start maintenance on", "length": 255, - "name": "clusterids", - "related": "addCluster,listClusters,updateCluster", + "name": "zoneids", + "related": "createZone,updateZone,listZones,listZones", "required": false, "type": "list" }, { - "description": "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": "optional operation timeout (in seconds) that overrides the global timeout setting", + "description": "the command to execute while hosts are on maintenance", "length": 255, - "name": "timeout", + "name": "payload", "required": false, - "type": "integer" + "type": "string" }, { - "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" }, { "description": "the IDs of the pods to start maintenance on", @@ -6616,48 +6940,37 @@ "description": "the IDs of the hosts to start maintenance on", "length": 255, "name": "hostids", - "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost,updateHost,addBaremetalHost,listExternalLoadBalancers", + "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost,updateHost", "required": false, "type": "list" }, { - "description": "the IDs of the zones to start maintenance on", + "description": "optional operation timeout (in seconds) that overrides the global timeout setting", "length": 255, - "name": "zoneids", - "related": "createZone,updateZone,listZones,listZones", + "name": "timeout", "required": false, - "type": "list" + "type": "integer" } ], "related": "", "response": [ - { - "description": "indicates if the rolling maintenance operation was successful", - "name": "success", - "type": "boolean" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "the hosts updated", "name": "hostsupdated", "response": [ { - "description": "output of the maintenance script on the host", - "name": "output", + "description": "the name of the updated host", + "name": "hostname", "type": "string" }, { - "description": "end date of the update on the host", - "name": "enddate", + "description": "start date of the update on the host", + "name": "startdate", "type": "string" }, { - "description": "the name of the updated host", - "name": "hostname", + "description": "output of the maintenance script on the host", + "name": "output", "type": "string" }, { @@ -6666,13 +6979,29 @@ "type": "string" }, { - "description": "start date of the update on the host", - "name": "startdate", + "description": "end date of the update on the host", + "name": "enddate", "type": "string" } ], "type": "list" }, + {}, + { + "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 current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "the hosts skipped", "name": "hostsskipped", @@ -6683,30 +7012,24 @@ "type": "string" }, { - "description": "the reason to skip the host", - "name": "reason", + "description": "the name of the skipped host", + "name": "hostname", "type": "string" }, { - "description": "the name of the skipped host", - "name": "hostname", + "description": "the reason to skip the host", + "name": "reason", "type": "string" } ], "type": "list" }, - {}, - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, { "description": "in case of failure, details are displayed", "name": "details", "type": "string" - } + }, + {} ] }, { @@ -6714,14 +7037,6 @@ "isasync": true, "name": "updateNetworkACLList", "params": [ - { - "description": "an optional field, whether to the display the list to the end user or not", - "length": 255, - "name": "fordisplay", - "required": false, - "since": "4.4", - "type": "boolean" - }, { "description": "Name of the network ACL list", "length": 255, @@ -6744,6 +7059,14 @@ "since": "4.4", "type": "string" }, + { + "description": "an optional field, whether to the display the list to the end user or not", + "length": 255, + "name": "fordisplay", + "required": false, + "since": "4.4", + "type": "boolean" + }, { "description": "the ID of the network ACL", "length": 255, @@ -6754,11 +7077,10 @@ } ], "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", @@ -6766,11 +7088,12 @@ "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", @@ -6780,127 +7103,98 @@ "since": "4.4" }, { - "description": "Restore a VM to original template/ISO or new template/ISO", - "isasync": true, - "name": "restoreVirtualMachine", + "description": "Reserve a public IP to an account.", + "isasync": false, + "name": "reserveIpAddress", "params": [ { - "description": "an optional template Id to restore vm from the new template. This can be an ISO id in case of restore vm deployed using ISO", + "description": "the account to reserve with this IP address", "length": 255, - "name": "templateid", - "related": "prepareTemplate,listIsos,registerIso,updateIso,copyTemplate,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", + "name": "account", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "Virtual Machine ID", + "description": "the ID of the project to reserve with this IP address", "length": 255, - "name": "virtualmachineid", - "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVmNicIp,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance", - "required": true, + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "required": false, "type": "uuid" - } - ], - "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVmNicIp,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance", - "response": [ - { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", - "type": "boolean" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "an optional field, whether to the display the IP to the end user or not", + "length": 255, + "name": "fordisplay", + "required": false, "type": "boolean" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" - }, - { - "description": "the name of the host for the virtual machine", - "name": "hostname", - "type": "string" - }, - { - "description": "the speed of each cpu", - "name": "cpuspeed", - "type": "integer" - }, - { - "description": "Guest vm Boot Mode", - "name": "bootmode", - "type": "string" - }, - {}, - { - "description": "the pool type of the virtual machine", - "name": "pooltype", - "type": "string" - }, - { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", - "type": "string" + "description": "the ID of the domain to reserve with this IP address", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", + "required": false, + "type": "uuid" }, { - "description": "the ID of the disk offering of the virtual machine", - "name": "diskofferingid", - "type": "string" - }, + "description": "the ID of the public IP address to reserve", + "length": 255, + "name": "id", + "related": "associateIpAddress,reserveIpAddress,listPublicIpAddresses,updateIpAddress,associateIpAddress,listPublicIpAddresses", + "required": true, + "type": "uuid" + } + ], + "related": "associateIpAddress,listPublicIpAddresses,updateIpAddress,associateIpAddress,listPublicIpAddresses", + "response": [ { - "description": "the group name of the virtual machine", - "name": "group", + "description": "VPC name the ip belongs to", + "name": "vpcname", "type": "string" }, { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", - "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 ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "the name of the zone the public IP address belongs to", + "name": "zonename", "type": "string" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "the account the public IP address is associated with", + "name": "account", "type": "string" }, { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", + "description": "the name of the Network associated with the IP address", + "name": "associatednetworkname", "type": "string" }, { - "description": "the list of resource tags associated", + "description": "the list of resource tags associated with ip address", "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 account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { @@ -6909,8 +7203,8 @@ "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { @@ -6919,108 +7213,575 @@ "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": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", "type": "string" } ], - "type": "set" + "type": "list" }, { - "description": "ssh key-pair", - "name": "keypair", + "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 virtual network for the service offering", - "name": "forvirtualnetwork", + "description": "true if the IP address is a source nat address, false otherwise", + "name": "issourcenat", "type": "boolean" }, { - "description": "OS name of the vm", - "name": "osdisplayname", + "description": "the VLAN associated with the IP address", + "name": "vlanname", "type": "string" }, { - "description": "State of the Service from LB rule", - "name": "servicestate", - "type": "string" + "description": "is public ip for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, - {}, { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", + "description": "State of the ip address. Can be: Allocatin, Allocated and Releasing", + "name": "state", "type": "string" }, { - "description": "the account associated with the virtual machine", - "name": "account", - "type": "string" + "description": "the virtual network for the IP address", + "name": "forvirtualnetwork", + "type": "boolean" }, { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", + "description": "virtual machine name the ip address is assigned to (not null only for static nat Ip)", + "name": "virtualmachinename", "type": "string" }, { - "description": "the read (bytes) of disk on the vm", - "name": "diskkbsread", - "type": "long" + "description": "is public IP portable across the zones", + "name": "isportable", + "type": "boolean" }, { - "description": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" + "description": "the domain ID the public IP address is associated with", + "name": "domainid", + "type": "string" }, { - "description": "the ID of the availablility zone for the virtual machine", - "name": "zoneid", - "type": "string" + "description": "date the public IP address was acquired", + "name": "allocated", + "type": "date" }, + {}, { - "description": "device type of the root volume", - "name": "rootdevicetype", + "description": "virtual machine id the ip address is assigned to (not null only for static nat Ip)", + "name": "virtualmachineid", "type": "string" }, { - "description": "the password (if exists) of the virtual machine", - "name": "password", + "description": "the ID of the Network where ip belongs to", + "name": "networkid", "type": "string" }, { - "description": "the outgoing network traffic on the host", - "name": "networkkbswrite", - "type": "long" + "description": "the domain the public IP address is associated with", + "name": "domain", + "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": "OS type id of the vm", - "name": "ostypeid", + "description": "public IP address", + "name": "ipaddress", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the name of the Network where ip belongs to", + "name": "networkname", + "type": "string" + }, + { + "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", + "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "true if this ip is for static nat, false otherwise", + "name": "isstaticnat", + "type": "boolean" + }, + { + "description": "virtual machine (dnat) ip address (not null only for static nat Ip)", + "name": "vmipaddress", "type": "string" }, {}, { - "description": "the internal memory that's free in vm or zero if it can not be calculated", - "name": "memoryintfreekbs", + "description": "the project name of the address", + "name": "project", + "type": "string" + }, + { + "description": "the ID of the Network associated with the IP address", + "name": "associatednetworkid", + "type": "string" + }, + { + "description": "the physical network this belongs to", + "name": "physicalnetworkid", + "type": "string" + }, + { + "description": "VPC id the ip belongs to", + "name": "vpcid", + "type": "string" + }, + { + "description": "the project id of the ipaddress", + "name": "projectid", + "type": "string" + }, + { + "description": "the ID of the zone the public IP address belongs to", + "name": "zoneid", + "type": "string" + }, + { + "description": "virtual machine display name the ip address is assigned to (not null only for static nat Ip)", + "name": "virtualmachinedisplayname", + "type": "string" + } + ], + "since": "4.17" + }, + { + "description": "Restore a VM to original template/ISO or new template/ISO", + "isasync": true, + "name": "restoreVirtualMachine", + "params": [ + { + "description": "Virtual Machine ID", + "length": 255, + "name": "virtualmachineid", + "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVmNicIp,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance", + "required": true, + "type": "uuid" + }, + { + "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", + "required": false, + "type": "uuid" + } + ], + "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVmNicIp,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance", + "response": [ + { + "description": "the ID of the availablility zone for the virtual machine", + "name": "zoneid", + "type": "string" + }, + { + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", + "type": "string" + }, + { + "description": "the group ID of the virtual machine", + "name": "groupid", + "type": "string" + }, + { + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", "type": "long" }, { - "description": "the memory used by the vm", - "name": "memorykbs", + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", + "type": "string" + }, + { + "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": "device ID of the root volume", + "name": "rootdeviceid", "type": "long" }, { - "description": "the target memory in vm", - "name": "memorytargetkbs", + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", + "type": "string" + }, + { + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" + }, + { + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", + "type": "string" + }, + { + "description": "State of the Service from LB rule", + "name": "servicestate", + "type": "string" + }, + { + "description": "the project name of the vm", + "name": "project", + "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": "ssh key-pairs", + "name": "keypairs", + "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": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", + "type": "string" + }, + { + "description": "the ID of the disk offering of the virtual machine", + "name": "diskofferingid", + "type": "string" + }, + { + "description": "the ID of the host for the virtual machine", + "name": "hostid", + "type": "string" + }, + { + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" + }, + { + "description": "Guest vm Boot Type", + "name": "boottype", + "type": "string" + }, + { + "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", + "type": "string" + }, + { + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", + "type": "string" + }, + { + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", + "type": "string" + }, + { + "description": "the state of the virtual machine", + "name": "state", + "type": "string" + }, + { + "description": "the name of the disk offering of the virtual machine", + "name": "diskofferingname", + "type": "string" + }, + { + "description": "Os type ID of the virtual machine", + "name": "guestosid", + "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": "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": "OS type id of the vm", + "name": "ostypeid", + "type": "string" + }, + { + "description": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", + "response": [ + { + "description": "the project name of the affinity group", + "name": "project", + "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 ID of the affinity group", + "name": "domainid", + "type": "string" + }, + { + "description": "the domain name of the affinity group", + "name": "domain", + "type": "string" + }, + { + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" + }, + { + "description": "the ID of the affinity group", + "name": "id", + "type": "string" + }, + { + "description": "the 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" + } + ], + "type": "set" + }, + { + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", + "type": "string" + }, + { + "description": "the user's ID who deployed the virtual machine", + "name": "userid", + "type": "string" + }, + {}, + { + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", + "type": "string" + }, + { + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", + "type": "string" + }, + { + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" + }, + { + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" + }, + { + "description": "the read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" + }, + { + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the 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": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" + }, + { + "description": "the name of the virtual machine", + "name": "name", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", + "type": "string" + }, + { + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" + }, + { + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" + }, + { + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" + }, + { + "description": "the user's name who deployed the virtual machine", + "name": "username", + "type": "string" + }, + { + "description": "OS name of the vm", + "name": "osdisplayname", + "type": "string" + }, + { + "description": "the memory used by the VM in KiB", + "name": "memorykbs", "type": "long" }, { @@ -7029,10 +7790,223 @@ "type": "long" }, { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", "type": "boolean" }, + { + "description": "the list of nics associated with vm", + "name": "nic", + "response": [ + { + "description": "the traffic type of the nic", + "name": "traffictype", + "type": "string" + }, + { + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", + "type": "string" + }, + { + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "the IPv6 address of network", + "name": "ip6address", + "type": "string" + }, + { + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" + }, + { + "description": "the 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": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", + "type": "string" + }, + { + "description": "the ID of the corresponding network", + "name": "networkid", + "type": "string" + }, + { + "description": "the gateway of the nic", + "name": "gateway", + "type": "string" + }, + { + "description": "the ip address of the nic", + "name": "ipaddress", + "type": "string" + }, + { + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "the 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 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": "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": "name of the vpc to which the nic belongs", + "name": "vpcname", + "type": "string" + }, + { + "description": "the broadcast uri of the nic", + "name": "broadcasturi", + "type": "string" + }, + { + "description": "the type of the nic", + "name": "type", + "type": "string" + }, + { + "description": "the isolation uri of the nic", + "name": "isolationuri", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "macaddress", + "type": "string" + }, + { + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" + } + ], + "type": "set" + }, + {}, + { + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" + }, + { + "description": "device type of the root volume", + "name": "rootdevicetype", + "type": "string" + }, + { + "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 account associated with the virtual machine", + "name": "account", + "type": "string" + }, + { + "description": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" + }, + { + "description": "Guest vm Boot Mode", + "name": "bootmode", + "type": "string" + }, + { + "description": "the pool type of the virtual machine", + "name": "pooltype", + "type": "string" + }, + { + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" + }, + { + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" + }, + { + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", + "type": "string" + }, + { + "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", @@ -7043,8 +8017,13 @@ "type": "string" }, { - "description": "the description of the security group", - "name": "description", + "description": "the name of the security group", + "name": "name", + "type": "string" + }, + { + "description": "the domain name of the security group", + "name": "domain", "type": "string" }, { @@ -7052,23 +8031,23 @@ "name": "tags", "response": [ { - "description": "the domain associated with the tag", - "name": "domain", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { @@ -7077,51 +8056,41 @@ "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 project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "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 name of the group", - "name": "project", - "type": "string" - }, { "description": "the list of egress rules associated with the security group", "name": "egressrule", "response": [ { - "description": "security group name", - "name": "securitygroupname", - "type": "string" + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" }, { "description": "the list of resource tags associated with the rule", @@ -7133,18 +8102,13 @@ "type": "string" }, { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { @@ -7153,13 +8117,8 @@ "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", + "description": "tag key name", + "name": "key", "type": "string" }, { @@ -7176,61 +8135,66 @@ "description": "the project name where tag belongs to", "name": "project", "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" } ], "type": "set" }, { - "description": "the ending IP of the security group rule ", - "name": "endport", + "description": "the code for the ICMP message response", + "name": "icmpcode", "type": "integer" }, { - "description": "the id of the security group rule", - "name": "ruleid", + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", "type": "string" }, { - "description": "the 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 protocol of the security group rule", + "name": "protocol", "type": "string" }, { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" + "description": "security group name", + "name": "securitygroupname", + "type": "string" }, { - "description": "the starting IP of the security group rule", - "name": "startport", + "description": "the 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 id of the security group rule", + "name": "ruleid", "type": "string" }, { - "description": "the protocol of the security group rule", - "name": "protocol", + "description": "account owning the security group rule", + "name": "account", "type": "string" } ], "type": "set" }, { - "description": "the project id of the group", - "name": "projectid", - "type": "string" - }, - { - "description": "the account owning the security group", - "name": "account", + "description": "the project name of the group", + "name": "project", "type": "string" }, { @@ -7239,19 +8203,14 @@ "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 starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, { "description": "account owning the security group rule", "name": "account", @@ -7262,19 +8221,19 @@ "name": "cidr", "type": "string" }, - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, { "description": "the type of the ICMP message response", "name": "icmptype", "type": "integer" }, { - "description": "the id of the security group rule", - "name": "ruleid", + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", "type": "string" }, { @@ -7282,8 +8241,18 @@ "name": "tags", "response": [ { - "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", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { @@ -7292,8 +8261,8 @@ "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { @@ -7302,8 +8271,8 @@ "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "tag value", + "name": "value", "type": "string" }, { @@ -7316,16 +8285,6 @@ "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 domain associated with the tag", "name": "domain", @@ -7335,374 +8294,65 @@ "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": "security group name", - "name": "securitygroupname", - "type": "string" - }, { "description": "the code for the ICMP message response", "name": "icmpcode", "type": "integer" + }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" } ], "type": "set" }, { - "description": "the name of the security group", - "name": "name", - "type": "string" - }, - { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" - } - ], - "type": "set" - }, - { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", - "type": "string" - }, - { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", - "type": "string" - }, - { - "description": "the ID of the host for the virtual machine", - "name": "hostid", - "type": "string" - }, - { - "description": "the project name of the vm", - "name": "project", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", - "type": "string" - }, - { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", - "type": "string" - }, - { - "description": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", - "response": [ - { - "description": "the domain ID of the affinity group", - "name": "domainid", - "type": "string" - }, - { - "description": "the project name of the affinity group", - "name": "project", - "type": "string" - }, - { - "description": "the ID of the affinity group", - "name": "id", + "description": "the account owning the security group", + "name": "account", "type": "string" }, { - "description": "the project ID of the affinity group", + "description": "the project id of the group", "name": "projectid", "type": "string" }, { - "description": "the type of the affinity group", - "name": "type", - "type": "string" - }, - { - "description": "the description of the affinity group", + "description": "the description of the security group", "name": "description", "type": "string" }, { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" - }, - { - "description": "the domain name of the affinity group", - "name": "domain", - "type": "string" - }, - { - "description": "the name of the affinity group", - "name": "name", - "type": "string" - }, - { - "description": "the account owning the affinity group", - "name": "account", - "type": "string" - } - ], - "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 incoming network traffic on the vm", - "name": "networkkbsread", - "type": "long" - }, - { - "description": "the vgpu type used by the virtual machine", - "name": "vgpu", - "type": "string" - }, - { - "description": "Guest vm Boot Type", - "name": "boottype", - "type": "string" - }, - { - "description": "the list of nics associated with vm", - "name": "nic", - "response": [ - { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", - "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": "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 IPv6 address of network", - "name": "ip6address", - "type": "string" - }, - { - "description": "the gateway of the nic", - "name": "gateway", - "type": "string" - }, - { - "description": "the ID of the nic", - "name": "id", - "type": "string" - }, - { - "description": "the ID of the corresponding network", - "name": "networkid", - "type": "string" - }, - { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", - "type": "string" - }, - { - "description": "the netmask of the nic", - "name": "netmask", - "type": "string" - }, - { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - }, - { - "description": "the isolation uri of the nic", - "name": "isolationuri", - "type": "string" - }, - { - "description": "the traffic type of the nic", - "name": "traffictype", - "type": "string" - }, - { - "description": "the name of the corresponding network", - "name": "networkname", - "type": "string" - }, - { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", - "type": "string" - }, - { - "description": "Type of adapter if available", - "name": "adaptertype", - "type": "string" - }, - { - "description": "the type of the nic", - "name": "type", - "type": "string" - }, - { - "description": "true if nic is default, false otherwise", - "name": "macaddress", - "type": "string" - }, - { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" - }, - { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" - }, - { - "description": "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 isolated private VLAN if available", - "name": "isolatedpvlan", + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", "type": "integer" - }, - { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", - "type": "string" } ], "type": "set" }, - { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", - "type": "string" - }, - { - "description": "the group ID of the virtual machine", - "name": "groupid", - "type": "string" - }, - { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", - "type": "string" - }, - { - "description": "the project id of the vm", - "name": "projectid", - "type": "string" - }, - { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", - "type": "string" - }, - { - "description": "the state of the virtual machine", - "name": "state", - "type": "string" - }, - { - "description": "the name of the template for the virtual machine", - "name": "templatename", - "type": "string" - }, - { - "description": "the write (io) of disk on the vm", - "name": "diskiowrite", - "type": "long" - }, - { - "description": "the user's name who deployed the virtual machine", - "name": "username", - "type": "string" - }, { "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", - "type": "string" - }, - { - "description": "Os type ID of the virtual machine", - "name": "guestosid", - "type": "string" - }, - { - "description": "the write (bytes) of disk on the vm", - "name": "diskkbswrite", - "type": "long" - }, - { - "description": "the name of the virtual machine", - "name": "name", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", + "name": "backupofferingname", "type": "string" }, { - "description": "the ID of the virtual machine", - "name": "id", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { - "description": "the number of cpu this virtual machine is running with", - "name": "cpunumber", - "type": "integer" + "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", + "type": "long" }, { "description": "true if high-availability is enabled, false otherwise", @@ -7710,50 +8360,11 @@ "type": "boolean" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", - "type": "string" - }, - { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", - "type": "string" - }, - { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", - "type": "string" - }, - { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", - "type": "string" - }, - { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" - }, - { - "description": "the read (io) of disk on the vm", - "name": "diskioread", - "type": "long" - }, - { - "description": "the name of the disk offering of the virtual machine", - "name": "diskofferingname", + "description": "the name of the host for the virtual machine", + "name": "hostname", "type": "string" }, - { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" - }, - { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - } + {} ], "since": "3.0.0" }, @@ -7762,13 +8373,6 @@ "isasync": false, "name": "deleteEvents", "params": [ - { - "description": "start date range to delete events (including) this date (use format \"yyyy-MM-dd\" or the new format \"yyyy-MM-ddThh:mm:ss\")", - "length": 255, - "name": "startdate", - "required": false, - "type": "date" - }, { "description": "delete by event type", "length": 255, @@ -7784,6 +8388,13 @@ "required": false, "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\")", + "length": 255, + "name": "startdate", + "required": false, + "type": "date" + }, { "description": "end date range to delete events (including) this date (use format \"yyyy-MM-dd\" or the new format \"yyyy-MM-ddThh:mm:ss\")", "length": 255, @@ -7798,22 +8409,22 @@ "name": "jobstatus", "type": "integer" }, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - }, + {}, {}, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" + }, + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" } ] }, @@ -7832,18 +8443,55 @@ } ], "response": [ + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + }, + {}, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + } + ] + }, + { + "description": "Notify provision has been done on a host. This api is for baremetal virtual router service, not for end user", + "isasync": true, + "name": "notifyBaremetalProvisionDone", + "params": [ + { + "description": "mac of the nic used for provision", + "length": 255, + "name": "mac", + "required": true, + "type": "object" + } + ], + "response": [ { "description": "the UUID of the latest async job acting on 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", @@ -7853,7 +8501,8 @@ "description": "true if operation is executed successfully", "name": "success", "type": "boolean" - } + }, + {} ] }, { @@ -7862,52 +8511,43 @@ "name": "listUcsBlades", "params": [ { - "description": "List by keyword", + "description": "ucs manager id", "length": 255, - "name": "keyword", - "required": false, - "type": "string" + "name": "ucsmanagerid", + "related": "listUcsManagers,addUcsManager", + "required": true, + "type": "uuid" }, { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, { - "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" } ], "related": "associateUcsProfileToBlade", "response": [ + {}, { - "description": "associated ucs profile dn", - "name": "profiledn", - "type": "string" - }, - { - "description": "cloudstack host id this blade associates to", - "name": "hostid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, {}, { "description": "ucs blade dn", @@ -7915,8 +8555,8 @@ "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "cloudstack host id this blade associates to", + "name": "hostid", "type": "string" }, { @@ -7925,49 +8565,20 @@ "type": "string" }, { - "description": "ucs manager id", - "name": "ucsmanagerid", - "type": "string" - }, - {} - ] - }, - { - "description": "Notify provision has been done on a host. This api is for baremetal virtual router service, not for end user", - "isasync": true, - "name": "notifyBaremetalProvisionDone", - "params": [ - { - "description": "mac of the nic used for provision", - "length": 255, - "name": "mac", - "required": true, - "type": "object" - } - ], - "response": [ - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "associated ucs profile dn", + "name": "profiledn", "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": "ucs manager id", + "name": "ucsmanagerid", "type": "string" }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - }, - {} + } ] }, { @@ -7990,16 +8601,16 @@ "name": "jobid", "type": "string" }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "Volume iSCSI Name", "name": "volumeiScsiName", "type": "string" }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, {}, {} ] @@ -8009,14 +8620,6 @@ "isasync": true, "name": "deleteIso", "params": [ - { - "description": "the ID of the zone of the ISO file. If not specified, the ISO will be deleted from all the zones", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": false, - "type": "uuid" - }, { "description": "the ID of the ISO file", "length": 255, @@ -8024,13 +8627,21 @@ "related": "prepareTemplate,listIsos,registerIso,updateIso,copyTemplate,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", "required": true, "type": "uuid" + }, + { + "description": "the ID of the zone of the ISO file. If not specified, the ISO will be deleted from all the zones", + "length": 255, + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": false, + "type": "uuid" } ], "response": [ { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "any text associated with the success or failure", @@ -8038,16 +8649,16 @@ "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" + }, {} ] }, @@ -8060,24 +8671,18 @@ "description": "Id of the external firewall appliance.", "length": 255, "name": "id", - "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost,updateHost,addBaremetalHost,listExternalLoadBalancers", + "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost,updateHost", "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", @@ -8087,6 +8692,12 @@ "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" } ] }, @@ -8096,18 +8707,20 @@ "name": "updateHost", "params": [ { - "description": "the new uri for the secondary storage: nfs://host/path", + "description": "Add an annotation to this host", "length": 255, - "name": "url", + "name": "annotation", "required": false, + "since": "4.11", "type": "string" }, { - "description": "list of tags to be added to the host", + "description": "the id of Os category to update the host with", "length": 255, - "name": "hosttags", + "name": "oscategoryid", + "related": "listOsCategories", "required": false, - "type": "list" + "type": "uuid" }, { "description": "Change resource state of host, valid values are [Enable, Disable]. Operation may failed if host in states not allowing Enable/Disable", @@ -8117,181 +8730,99 @@ "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", + "description": "list of tags to be added to the host", "length": 255, - "name": "name", + "name": "hosttags", "required": false, - "since": "4.15", - "type": "string" + "type": "list" }, { "description": "the ID of the host to update", "length": 255, "name": "id", - "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost,updateHost,addBaremetalHost,listExternalLoadBalancers", + "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost,updateHost", "required": true, "type": "uuid" }, { - "description": "Add an annotation to this host", + "description": "the new uri for the secondary storage: nfs://host/path", "length": 255, - "name": "annotation", + "name": "url", "required": false, - "since": "4.11", + "type": "string" + }, + { + "description": "Change the name of host", + "length": 255, + "name": "name", + "required": false, + "since": "4.15", "type": "string" } ], - "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost,addBaremetalHost,listExternalLoadBalancers", + "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost", "response": [ { - "description": "the amount of the host's memory currently used", - "name": "memoryused", - "type": "long" - }, - { - "description": "the amount of the host's CPU currently allocated in MHz", - "name": "cpuallocatedvalue", - "type": "long" - }, - { - "description": "the CPU number of the host", - "name": "cpunumber", - "type": "integer" - }, - { - "description": "the outgoing network traffic on the host", - "name": "networkkbswrite", - "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 bytes", - "name": "memoryallocatedbytes", - "type": "long" - }, - { - "description": "the cpu average load on the host", - "name": "cpuloadaverage", - "type": "double" - }, - { - "description": "the last annotation set on this host by an admin", - "name": "annotation", + "description": "events available for the host", + "name": "events", "type": "string" }, { - "description": "the incoming network traffic on the host", - "name": "networkkbsread", - "type": "long" - }, - { - "description": "the management server ID of the host", - "name": "managementserverid", + "description": "the cluster 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 cluster ID of the host", - "name": "clusterid", + "description": "the OS category name of the host", + "name": "oscategoryname", "type": "string" }, { - "description": "the Zone name of the host", - "name": "zonename", + "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor", + "name": "cpuwithoverprovisioning", "type": "string" }, { - "description": "the total disk size of the host", - "name": "disksizetotal", - "type": "long" + "description": "the CPU number of the host", + "name": "cpunumber", + "type": "integer" }, { - "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 cluster type of the cluster that host belongs to", - "name": "clustertype", + "description": "the ID of the host", + "name": "id", "type": "string" }, { - "description": "the amount of the host's memory currently allocated", - "name": "memoryallocated", + "description": "the host's currently allocated disk size", + "name": "disksizeallocated", "type": "long" }, { - "description": "true if local storage is active, false otherwise", - "name": "islocalstorageactive", - "type": "boolean" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the Zone ID of the host", - "name": "zoneid", - "type": "string" - }, - { - "description": "the name of the host", - "name": "name", - "type": "string" - }, - { - "description": "true if the host has capability to support UEFI boot", - "name": "ueficapability", - "type": "boolean" - }, - { - "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", - "name": "cpuallocatedwithoverprovisioning", + "description": "the amount of the host's memory after applying the mem.overprovisioning.factor", + "name": "memorywithoverprovisioning", "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": "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", + "description": "Maximum X resolution per display", + "name": "maxresolutionx", "type": "long" }, { - "description": "Maximum no. of vgpu per gpu card (pgpu)", - "name": "maxvgpuperpgpu", + "description": "Video RAM for this vGPU type", + "name": "videoram", "type": "long" }, { @@ -8300,59 +8831,119 @@ "type": "long" }, { - "description": "Video RAM for this vGPU type", - "name": "videoram", + "description": "Maximum Y resolution per display", + "name": "maxresolutiony", "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": "Model Name of vGPU", - "name": "vgputype", - "type": "string" - }, { "description": "Maximum displays per user", "name": "maxheads", "type": "long" + }, + { + "description": "Maximum no. of vgpu per gpu card (pgpu)", + "name": "maxvgpuperpgpu", + "type": "long" } ], "type": "list" + }, + { + "description": "GPU cards present in the host", + "name": "gpugroupname", + "type": "string" } ], "type": "list" }, { - "description": "the amount of the host's memory after applying the mem.overprovisioning.factor", - "name": "memorywithoverprovisioning", + "description": "the Zone ID of the host", + "name": "zoneid", + "type": "string" + }, + { + "description": "the hypervisor version", + "name": "hypervisorversion", + "type": "string" + }, + { + "description": "the host hypervisor", + "name": "hypervisor", + "type": "hypervisortype" + }, + { + "description": "the date and time the host was last pinged", + "name": "lastpinged", + "type": "date" + }, + { + "description": "comma-separated list of tags for the host", + "name": "hosttags", + "type": "string" + }, + { + "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise", + "name": "hahost", + "type": "boolean" + }, + { + "description": "the last time this host was annotated", + "name": "lastannotated", + "type": "date" + }, + { + "description": "the number of CPU sockets on the host", + "name": "cpusockets", + "type": "integer" + }, + { + "description": "the cluster ID of the host", + "name": "clusterid", + "type": "string" + }, + { + "description": "the amount of the host's memory currently allocated in percentage", + "name": "memoryallocatedpercentage", + "type": "string" + }, + { + "description": "the host out-of-band management information", + "name": "outofbandmanagement", + "type": "outofbandmanagementresponse" + }, + { + "description": "the name of the host", + "name": "name", "type": "string" }, { - "description": "the host HA information information", - "name": "hostha", - "type": "hostharesponse" + "description": "Host details in key/value pairs.", + "name": "details", + "type": "map" + }, + { + "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", + "name": "memorytotal", + "type": "long" }, { - "description": "the cluster name of the host", - "name": "clustername", + "description": "the OS category ID of the host", + "name": "oscategoryid", "type": "string" }, { - "description": "true if the host is disconnected. False otherwise.", - "name": "disconnected", - "type": "date" - }, - { - "description": "the Pod ID of the host", - "name": "podid", + "description": "the host version", + "name": "version", "type": "string" }, { @@ -8361,28 +8952,18 @@ "type": "string" }, { - "description": "the date and time the host was created", - "name": "created", - "type": "date" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the CPU speed of the host", - "name": "cpuspeed", - "type": "long" + "description": "true if the host has capability to support UEFI boot", + "name": "ueficapability", + "type": "boolean" }, { - "description": "the host version", - "name": "version", + "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", + "name": "cpuallocatedwithoverprovisioning", "type": "string" }, { - "description": "the OS category ID of the host", - "name": "oscategoryid", + "description": "the last annotation set on this host by an admin", + "name": "annotation", "type": "string" }, { @@ -8391,23 +8972,40 @@ "type": "string" }, { - "description": "the last time this host was annotated", - "name": "lastannotated", + "description": "the date and time the host was removed", + "name": "removed", "type": "date" }, { - "description": "the host hypervisor", - "name": "hypervisor", - "type": "hypervisortype" + "description": "true if local storage is active, false otherwise", + "name": "islocalstorageactive", + "type": "boolean" }, + {}, { - "description": "the date and time the host was removed", - "name": "removed", - "type": "date" + "description": "true if this host is suitable(has enough capacity and satisfies all conditions like hosttags, max guests vm limit etc) to migrate a VM to it , false otherwise", + "name": "suitableformigration", + "type": "boolean" }, { - "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor", - "name": "cpuwithoverprovisioning", + "description": "the management server ID of the host", + "name": "managementserverid", + "type": "string" + }, + {}, + { + "description": "the admin that annotated this host", + "name": "username", + "type": "string" + }, + { + "description": "the incoming network traffic on the host", + "name": "networkkbsread", + "type": "long" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -8415,102 +9013,115 @@ "name": "hasenoughcapacity", "type": "boolean" }, - { - "description": "the host out-of-band management information", - "name": "outofbandmanagement", - "type": "outofbandmanagementresponse" - }, { "description": "the IP address of the host", "name": "ipaddress", "type": "string" }, { - "description": "the amount of the host's CPU currently allocated in percentage", - "name": "cpuallocatedpercentage", - "type": "string" + "description": "the amount of the host's memory currently allocated in bytes", + "name": "memoryallocatedbytes", + "type": "long" }, { - "description": "the hypervisor version", - "name": "hypervisorversion", + "description": "the total disk size of the host", + "name": "disksizetotal", + "type": "long" + }, + { + "description": "the state of the host", + "name": "state", + "type": "status" + }, + { + "description": "the cluster name of the host", + "name": "clustername", "type": "string" }, { - "description": "comma-separated list of tags for the host", - "name": "hosttags", + "description": "the Pod ID of the host", + "name": "podid", "type": "string" }, { - "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise", - "name": "hahost", - "type": "boolean" + "description": "the CPU speed of the host", + "name": "cpuspeed", + "type": "long" }, { - "description": "the OS category name of the host", - "name": "oscategoryname", + "description": "the Zone name of the host", + "name": "zonename", "type": "string" }, { - "description": "capabilities of the host", - "name": "capabilities", + "description": "the amount of the host's CPU currently allocated in percentage", + "name": "cpuallocatedpercentage", "type": "string" }, - {}, { - "description": "the state of the host", - "name": "state", - "type": "status" + "description": "the amount of the host's memory currently allocated", + "name": "memoryallocated", + "type": "long" }, - {}, { - "description": "the resource state of the host", - "name": "resourcestate", + "description": "capabilities of the host", + "name": "capabilities", "type": "string" }, { - "description": "events available for the host", - "name": "events", - "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": "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", + "description": "the amount of the host's memory currently used", + "name": "memoryused", "type": "long" }, { - "description": "the amount of the host's memory currently allocated in percentage", - "name": "memoryallocatedpercentage", - "type": "string" + "description": "the outgoing network traffic on the host", + "name": "networkkbswrite", + "type": "long" }, { - "description": "the number of CPU sockets on the host", - "name": "cpusockets", - "type": "integer" + "description": "true if the host is disconnected. False otherwise.", + "name": "disconnected", + "type": "date" }, { - "description": "the amount of the host's CPU currently used", - "name": "cpuused", - "type": "string" + "description": "the cpu average load on the host", + "name": "cpuloadaverage", + "type": "double" }, { - "description": "the admin that annotated this host", - "name": "username", + "description": "the resource state of the host", + "name": "resourcestate", "type": "string" }, { - "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 type", "name": "type", "type": "type" + }, + { + "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" } ] }, @@ -8520,9 +9131,16 @@ "name": "createEgressFirewallRule", "params": [ { - "description": "the ending port of firewall rule", + "description": "the cidr list to forward traffic from. Multiple entries must be separated by a single comma character (,).", "length": 255, - "name": "endport", + "name": "cidrlist", + "required": false, + "type": "list" + }, + { + "description": "error code for this icmp message", + "length": 255, + "name": "icmpcode", "required": false, "type": "integer" }, @@ -8534,16 +9152,17 @@ "type": "string" }, { - "description": "the starting port of firewall rule", + "description": "an optional field, whether to the display the rule to the end user or not", "length": 255, - "name": "startport", + "name": "fordisplay", "required": false, - "type": "integer" + "since": "4.4", + "type": "boolean" }, { - "description": "error code for this icmp message", + "description": "the starting port of firewall rule", "length": 255, - "name": "icmpcode", + "name": "startport", "required": false, "type": "integer" }, @@ -8562,19 +9181,19 @@ "type": "integer" }, { - "description": "the cidr list to forward traffic from. Multiple entries must be separated by a single comma character (,).", + "description": "the network id of the port forwarding rule", "length": 255, - "name": "cidrlist", - "required": false, - "type": "list" + "name": "networkid", + "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listSrxFirewallNetworks,listBrocadeVcsDeviceNetworks", + "required": true, + "type": "uuid" }, { - "description": "an optional field, whether to the display the rule to the end user or not", + "description": "the ending port of firewall rule", "length": 255, - "name": "fordisplay", + "name": "endport", "required": false, - "since": "4.4", - "type": "boolean" + "type": "integer" }, { "description": "type of firewallrule: system/user", @@ -8582,14 +9201,6 @@ "name": "type", "required": false, "type": "string" - }, - { - "description": "the network id of the port forwarding rule", - "length": 255, - "name": "networkid", - "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listF5LoadBalancerNetworks,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listSrxFirewallNetworks,listBrocadeVcsDeviceNetworks", - "required": true, - "type": "uuid" } ], "related": "createFirewallRule,listEgressFirewallRules,listFirewallRules,updateEgressFirewallRule", @@ -8599,6 +9210,21 @@ "name": "jobid", "type": "string" }, + { + "description": "is rule for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, + { + "description": "the cidr list to forward traffic to. Multiple entries are separated by a single comma character (,).", + "name": "destcidrlist", + "type": "string" + }, + { + "description": "type of the icmp message being sent", + "name": "icmptype", + "type": "integer" + }, {}, { "description": "the starting port of firewall rule's port range", @@ -8606,32 +9232,58 @@ "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 network id of the firewall rule", + "name": "networkid", + "type": "string" + }, + { + "description": "the ID of the firewall rule", + "name": "id", + "type": "string" + }, + { + "description": "the state of the rule", + "name": "state", + "type": "string" + }, + { + "description": "the public ip address id for the firewall rule", + "name": "ipaddressid", + "type": "string" }, { "description": "error code for this icmp message", "name": "icmpcode", "type": "integer" }, + { + "description": "the public ip address for the firewall rule", + "name": "ipaddress", + "type": "string" + }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, { "description": "tag key name", "name": "key", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { @@ -8639,93 +9291,57 @@ "name": "project", "type": "string" }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, { "description": "the domain associated with the tag", "name": "domain", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the 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", "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" } ], "type": "list" }, { - "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 protocol of the firewall rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the cidr list to forward traffic to. Multiple entries are separated by a single comma character (,).", - "name": "destcidrlist", - "type": "string" - }, - { - "description": "the network id of the firewall rule", - "name": "networkid", - "type": "string" - }, - { - "description": "the state of the rule", - "name": "state", - "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", + "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 current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the public ip address id for the firewall rule", - "name": "ipaddressid", + "description": "the protocol of the firewall rule", + "name": "protocol", "type": "string" } ] @@ -8743,13 +9359,18 @@ "type": "string" }, { - "description": "id of zone disk offering is associated with", + "description": "true if need to list only default VPC offerings. Default value is false", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "isdefault", "required": false, - "since": "4.13", - "type": "uuid" + "type": "boolean" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" }, { "description": "List by keyword", @@ -8759,19 +9380,21 @@ "type": "string" }, { - "description": "list VPC offerings by id", + "description": "id of zone disk offering is associated with", "length": 255, - "name": "id", - "related": "updateVPCOffering,listVPCOfferings", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, + "since": "4.13", "type": "uuid" }, { - "description": "", + "description": "list VPC offerings by id", "length": 255, - "name": "page", + "name": "id", + "related": "updateVPCOffering,listVPCOfferings", "required": false, - "type": "integer" + "type": "uuid" }, { "description": "list VPC offerings by display text", @@ -8780,20 +9403,6 @@ "required": false, "type": "string" }, - { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, - { - "description": "true if need to list only default VPC offerings. Default value is false", - "length": 255, - "name": "isdefault", - "required": false, - "type": "boolean" - }, { "description": "list VPC offerings supporting certain services", "length": 255, @@ -8807,54 +9416,25 @@ "name": "name", "required": false, "type": "string" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" } ], "related": "updateVPCOffering", "response": [ - { - "description": "the name of the vpc 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 vpc offering is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": " indicated if the offering can support region level vpc", - "name": "supportsregionLevelvpc", - "type": "boolean" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - {}, - { - "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zoneid", - "type": "string" - }, - { - "description": "the id of the vpc offering", - "name": "id", - "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": "the name of the vpc offering", + "name": "name", "type": "string" }, { @@ -8862,64 +9442,64 @@ "name": "service", "response": [ { - "description": "the service provider name", - "name": "provider", + "description": "the list of capabilities", + "name": "capability", "response": [ { - "description": "true if individual services can be enabled/disabled", - "name": "canenableindividualservice", - "type": "boolean" - }, - { - "description": "the provider name", + "description": "the capability name", "name": "name", "type": "string" }, { - "description": "services for this provider", - "name": "servicelist", - "type": "list" + "description": "can this service capability value can be choosable while creatine network offerings", + "name": "canchooseservicecapability", + "type": "boolean" }, { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", + "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": "true if individual services can be enabled/disabled", + "name": "canenableindividualservice", + "type": "boolean" }, { "description": "state of the network provider", "name": "state", "type": "string" }, + { + "description": "the provider name", + "name": "name", + "type": "string" + }, { "description": "uuid of the network provider", "name": "id", "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": "services for this provider", + "name": "servicelist", + "type": "list" }, { - "description": "the capability name", - "name": "name", + "description": "the destination physical network", + "name": "destinationphysicalnetworkid", "type": "string" }, { - "description": "the capability value", - "name": "value", + "description": "the physical network this belongs to", + "name": "physicalnetworkid", "type": "string" } ], @@ -8934,29 +9514,70 @@ "type": "list" }, { - "description": " indicates if the vpc offering supports distributed router for one-hop forwarding", - "name": "distributedvpcrouter", - "type": "boolean" + "description": "the id of the vpc offering", + "name": "id", + "type": "string" }, {}, + { + "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "zoneid", + "type": "string" + }, { "description": "an alternate display text of the vpc offering.", "name": "displaytext", "type": "string" }, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": " indicated if the offering can support region level vpc", + "name": "supportsregionLevelvpc", + "type": "boolean" + }, + { + "description": "the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "domainid", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "state of the vpc offering. Can be Disabled/Enabled", + "name": "state", "type": "string" }, + { + "description": "true if vpc offering is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, { "description": "the date this vpc offering was created", "name": "created", "type": "date" }, { - "description": "the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "domainid", + "description": "the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "zone", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": " indicates if the vpc offering supports distributed router for one-hop forwarding", + "name": "distributedvpcrouter", + "type": "boolean" + }, + { + "description": "the internet protocol of the vpc offering", + "name": "internetprotocol", "type": "string" } ] @@ -8976,22 +9597,22 @@ ], "related": "", "response": [ + {}, {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "SolidFire Volume Size Including Hypervisor Snapshot Reserve", + "name": "solidFireVolumeSize", + "type": "long" }, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "SolidFire Volume Size Including Hypervisor Snapshot Reserve", - "name": "solidFireVolumeSize", - "type": "long" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ] }, @@ -9001,33 +9622,42 @@ "name": "uploadVolume", "params": [ { - "description": "Upload volume for the project", + "description": "the ID of the zone the volume is to be hosted on", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": true, + "type": "uuid" + }, + { + "description": "the ID of the disk offering. This must be a custom sized offering since during uploadVolume volume size is unknown.", + "length": 255, + "name": "diskofferingid", + "related": "createDiskOffering,updateDiskOffering,listDiskOfferings", "required": false, "type": "uuid" }, { - "description": "the name of the volume", + "description": "the format for the volume. Possible values include QCOW2, OVA, and VHD.", "length": 255, - "name": "name", + "name": "format", "required": true, "type": "string" }, { - "description": "Image store uuid", + "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": "imagestoreuuid", + "name": "checksum", "required": false, "type": "string" }, { - "description": "an optional accountName. Must be used with domainId.", + "description": "an optional domainId. If the account parameter is used, domainId must also be used.", "length": 255, - "name": "account", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", "required": false, - "type": "string" + "type": "uuid" }, { "description": "the URL of where the volume is hosted. Possible URL include http:// and https://", @@ -9037,114 +9667,115 @@ "type": "string" }, { - "description": "the ID of the disk offering. This must be a custom sized offering since during uploadVolume volume size is unknown.", + "description": "the name of the volume", "length": 255, - "name": "diskofferingid", - "related": "createDiskOffering,updateDiskOffering,listDiskOfferings", - "required": false, - "type": "uuid" + "name": "name", + "required": true, + "type": "string" }, { - "description": "an optional domainId. If the account parameter is used, domainId must also be used.", + "description": "Upload volume for the project", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", "required": false, "type": "uuid" }, { - "description": "the format for the volume. Possible values include QCOW2, OVA, and VHD.", + "description": "an optional accountName. Must be used with domainId.", "length": 255, - "name": "format", - "required": true, + "name": "account", + "required": false, "type": "string" }, { - "description": "the checksum value of this volume. The parameter containing the checksum will be considered a MD5sum if it is not prefixed\n and just a plain ascii/utf8 representation of a hexadecimal string. If it is required to\n use another algorithm the hexadecimal string is to be prefixed with a string of the form,\n \"{}\", not including the double quotes. In this is the exact string\n representing the java supported algorithm, i.e. MD5 or SHA-256. Note that java does not\n contain an algorithm called SHA256 or one called sha-256, only SHA-256.", + "description": "Image store uuid", "length": 255, - "name": "checksum", + "name": "imagestoreuuid", "required": false, "type": "string" - }, - { - "description": "the ID of the zone the volume is to be hosted on", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": true, - "type": "uuid" } ], - "related": "attachVolume,createVolume,updateVolume,detachVolume,listVolumes,migrateVolume,resizeVolume,destroyVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", + "related": "attachVolume,createVolume,updateVolume,detachVolume,listVolumes,migrateVolume,resizeVolume,destroyVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", "response": [ { - "description": "true if the volume is extractable, false otherwise", - "name": "isextractable", - "type": "boolean" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" + }, + { + "description": "the display text of the disk offering", + "name": "diskofferingdisplaytext", "type": "string" }, { - "description": "the path of the volume", - "name": "path", + "description": "name of the virtual machine", + "name": "vmname", "type": "string" }, { - "description": "the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached.", - "name": "deviceid", + "description": "type of the disk volume (ROOT or DATADISK)", + "name": "type", + "type": "string" + }, + { + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", "type": "long" }, { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", + "description": "volume uuid that is given by virtualisation provider (only for VMware)", + "name": "externaluuid", "type": "string" }, { - "description": "the account associated with the disk volume", - "name": "account", + "description": "ID of the disk volume", + "name": "id", "type": "string" }, { - "description": "the status of the volume", - "name": "status", - "type": "string" + "description": "the date the disk volume was created", + "name": "created", + "type": "date" }, { - "description": "Hypervisor the volume belongs to", - "name": "hypervisor", + "description": "the project name of the vpn", + "name": "project", "type": "string" }, { - "description": "io requests read rate of the disk volume per the disk offering", - "name": "diskIopsReadRate", - "type": "long" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "need quiesce vm or not when taking snapshot", - "name": "quiescevm", - "type": "boolean" + "description": "cluster name where the volume is allocated", + "name": "clustername", + "type": "string" }, { - "description": "name of the primary storage hosting the disk volume", - "name": "storage", + "description": "the chain info of the volume", + "name": "chaininfo", "type": "string" }, { - "description": "the bytes allocated", - "name": "physicalsize", - "type": "long" + "description": "pod id of the volume", + "name": "podid", + "type": "string" }, { - "description": "the ID of the domain associated with the disk volume", - "name": "domainid", + "description": "pod name of the volume", + "name": "podname", "type": "string" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { @@ -9153,19 +9784,25 @@ "type": "string" }, { - "description": "the bytes actually consumed on disk", - "name": "virtualsize", + "description": "an optional field whether to the display the volume to the end user or not.", + "name": "displayvolume", + "type": "boolean" + }, + {}, + { + "description": "bytes read rate of the disk volume", + "name": "diskBytesReadRate", "type": "long" }, { - "description": "ID of the availability zone", - "name": "zoneid", + "description": "name of the disk offering", + "name": "diskofferingname", "type": "string" }, { - "description": "the disk utilization", - "name": "utilization", - "type": "string" + "description": "IO requests write rate of the disk volume per the disk offering", + "name": "diskIopsWriteRate", + "type": "long" }, { "description": "name of the availability zone", @@ -9173,33 +9810,79 @@ "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "the ID of 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 write (IO) of disk on the vm", + "name": "diskiowrite", + "type": "long" + }, + { + "description": "size of the disk volume", + "name": "size", + "type": "long" + }, + { + "description": "the display text of the service offering for root disk", + "name": "serviceofferingdisplaytext", + "type": "string" + }, + { + "description": "shared or local storage", + "name": "storagetype", + "type": "string" + }, + { + "description": "the status of the volume", + "name": "status", + "type": "string" + }, + { + "description": "true if the volume is extractable, false otherwise", + "name": "isextractable", "type": "boolean" }, { - "description": "the project name of the vpn", - "name": "project", + "description": "id of the primary storage hosting the disk volume; returned to admin user only", + "name": "storageid", "type": "string" }, { - "description": "pod name of the volume", - "name": "podname", + "description": "state of the virtual machine", + "name": "vmstate", "type": "string" }, { - "description": "the write (io) of disk on the vm", - "name": "diskiowrite", + "description": "IO requests read rate of the disk volume per the disk offering", + "name": "diskIopsReadRate", "type": "long" }, { - "description": "cluster id of the volume", - "name": "clusterid", + "description": "display name of the virtual machine", + "name": "vmdisplayname", "type": "string" }, { - "description": "the read (io) of disk on the vm", - "name": "diskioread", + "description": "the date the volume was attached to a VM instance", + "name": "attached", + "type": "date" + }, + { + "description": "the domain associated with the disk volume", + "name": "domain", + "type": "string" + }, + { + "description": "min iops of the disk volume", + "name": "miniops", "type": "long" }, { @@ -9208,10 +9891,55 @@ "type": "string" }, { - "description": "the write (bytes) of disk on the vm", - "name": "diskkbswrite", + "description": "the read (IO) of disk on the vm", + "name": "diskioread", "type": "long" }, + { + "description": "the ID of the domain associated with the disk volume", + "name": "domainid", + "type": "string" + }, + { + "description": "bytes write rate of the disk volume", + "name": "diskBytesWriteRate", + "type": "long" + }, + { + "description": "name of the disk volume", + "name": "name", + "type": "string" + }, + { + "description": "the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached.", + "name": "deviceid", + "type": "long" + }, + { + "description": "name of the primary storage hosting the disk volume", + "name": "storage", + "type": "string" + }, + { + "description": "ID of the availability zone", + "name": "zoneid", + "type": "string" + }, + { + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", + "type": "string" + }, + { + "description": "need quiesce vm or not when taking snapshot", + "name": "quiescevm", + "type": "boolean" + }, + { + "description": "the state of the disk volume", + "name": "state", + "type": "string" + }, { "description": "the list of resource tags associated", "name": "tags", @@ -9222,8 +9950,8 @@ "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { @@ -9231,16 +9959,6 @@ "name": "resourcetype", "type": "string" }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, { "description": "tag value", "name": "value", @@ -9252,8 +9970,13 @@ "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", "type": "string" }, { @@ -9265,93 +9988,28 @@ "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": "min iops of the disk volume", - "name": "miniops", - "type": "long" - }, - { - "description": "bytes read rate of the disk volume", - "name": "diskBytesReadRate", - "type": "long" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "ID of the service offering for root disk", - "name": "serviceofferingid", - "type": "string" - }, - { - "description": "the date the disk volume was created", - "name": "created", - "type": "date" - }, - { - "description": "ID of the disk volume", - "name": "id", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the display text of the service offering for root disk", - "name": "serviceofferingdisplaytext", - "type": "string" - }, - { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", - "type": "string" - }, - { - "description": "the date the volume was attached to a VM instance", - "name": "attached", - "type": "date" - }, - { - "description": "name of the virtual machine", - "name": "vmname", - "type": "string" - }, - { - "description": "id of the primary storage hosting the disk volume; returned to admin user only", - "name": "storageid", - "type": "string" - }, - { - "description": "id of the virtual machine", - "name": "virtualmachineid", - "type": "string" - }, - { - "description": "display name of the virtual machine", - "name": "vmdisplayname", - "type": "string" - }, - { - "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 domain associated with the disk volume", - "name": "domain", + "description": "provisioning type used to create volumes.", + "name": "provisioningtype", "type": "string" }, { - "description": "the state of the disk volume", - "name": "state", + "description": "Hypervisor the volume belongs to", + "name": "hypervisor", "type": "string" }, { @@ -9360,105 +10018,73 @@ "type": "boolean" }, { - "description": "name of the disk volume", - "name": "name", - "type": "string" - }, - { - "description": "max iops of the disk volume", - "name": "maxiops", - "type": "long" - }, - { - "description": "name of the service offering for root disk", - "name": "serviceofferingname", + "description": "the path of the volume", + "name": "path", "type": "string" }, - {}, { - "description": "pod id of the volume", - "name": "podid", + "description": "cluster id of the volume", + "name": "clusterid", "type": "string" }, { - "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": "cluster name where the volume is allocated", - "name": "clustername", + "description": "the disk utilization", + "name": "utilization", "type": "string" }, { - "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", + "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": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", - "type": "string" - }, - { - "description": "the display text of the disk offering", - "name": "diskofferingdisplaytext", + "description": "ID of the service offering for root disk", + "name": "serviceofferingid", "type": "string" }, { - "description": "an optional field whether to the display the volume to the end user or not.", - "name": "displayvolume", - "type": "boolean" - }, - { - "description": "the chain info of the volume", - "name": "chaininfo", + "description": "name of the service offering for root disk", + "name": "serviceofferingname", "type": "string" }, { - "description": "state of the virtual machine", - "name": "vmstate", + "description": "the account associated with the disk volume", + "name": "account", "type": "string" }, { - "description": "the read (bytes) of disk on the vm", - "name": "diskkbsread", - "type": "long" + "description": "id of the virtual machine", + "name": "virtualmachineid", + "type": "string" }, - {}, { - "description": "bytes write rate of the disk volume", - "name": "diskBytesWriteRate", + "description": "max iops of the disk volume", + "name": "maxiops", "type": "long" }, { - "description": "provisioning type used to create volumes.", - "name": "provisioningtype", + "description": "ID of the snapshot from which this volume was created", + "name": "snapshotid", "type": "string" }, { - "description": "true if storage snapshot is supported for the volume, false otherwise", - "name": "supportsstoragesnapshot", - "type": "boolean" + "description": "the name of the template for the virtual machine", + "name": "templatename", + "type": "string" }, { - "description": "shared or local storage", - "name": "storagetype", - "type": "string" + "description": "the bytes allocated", + "name": "physicalsize", + "type": "long" }, { - "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" } ] @@ -9469,57 +10095,55 @@ "name": "listSecurityGroups", "params": [ { - "description": "lists security groups by name", + "description": "List resources by tags (key/value pairs)", "length": 255, - "name": "securitygroupname", + "name": "tags", "required": false, - "type": "string" + "type": "map" }, { - "description": "lists security groups by virtual machine 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": "virtualmachineid", - "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVmNicIp,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance", + "name": "listall", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "list the security group by the id provided", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "id", - "related": "createSecurityGroup,listSecurityGroups,updateSecurityGroup", + "name": "isrecursive", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "", + "description": "list the security group by the id provided", "length": 255, - "name": "page", + "name": "id", + "related": "createSecurityGroup,listSecurityGroups,updateSecurityGroup", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "List resources by tags (key/value pairs)", + "description": "lists security groups by name", "length": 255, - "name": "tags", + "name": "securitygroupname", "required": false, - "type": "map" + "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": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", "required": false, "type": "uuid" }, { - "description": "list objects by project", + "description": "List by keyword", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" }, { "description": "list resources by account. Must be used with the domainId parameter.", @@ -9529,30 +10153,32 @@ "type": "string" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false", + "description": "lists security groups by virtual machine id", "length": 255, - "name": "listall", + "name": "virtualmachineid", + "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVmNicIp,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "isrecursive", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", "required": false, - "type": "boolean" + "type": "uuid" }, { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" } @@ -9564,25 +10190,25 @@ "name": "domain", "type": "string" }, - { - "description": "the ID of the security group", - "name": "id", - "type": "string" - }, - { - "description": "the name of the security group", - "name": "name", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "the list of ingress rules associated with the security group", "name": "ingressrule", "response": [ + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "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", @@ -9594,8 +10220,13 @@ "type": "string" }, { - "description": "the ending IP of the security group rule ", - "name": "endport", + "description": "account owning the security group rule", + "name": "account", + "type": "string" + }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", "type": "integer" }, { @@ -9603,23 +10234,18 @@ "name": "tags", "response": [ { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "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" }, { @@ -9633,13 +10259,13 @@ "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 ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { @@ -9648,36 +10274,21 @@ "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", "type": "string" } ], "type": "set" }, { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "account owning the security group rule", - "name": "account", - "type": "string" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", + "description": "the ending IP of the security group rule ", + "name": "endport", "type": "integer" }, { @@ -9688,38 +10299,24 @@ ], "type": "set" }, - { - "description": "the description of the security group", - "name": "description", - "type": "string" - }, - { - "description": "the domain ID of the security group", - "name": "domainid", - "type": "string" - }, - { - "description": "the 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 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": "customer associated with the tag", - "name": "customer", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { @@ -9733,13 +10330,8 @@ "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { @@ -9748,55 +10340,41 @@ "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "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 UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the project id of the group", - "name": "projectid", - "type": "string" - }, { "description": "the list of egress rules associated with the security group", "name": "egressrule", "response": [ { - "description": "the protocol of the security group rule", - "name": "protocol", + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", "type": "string" }, { - "description": "the id of the security group rule", - "name": "ruleid", + "description": "the protocol of the security group rule", + "name": "protocol", "type": "string" }, { @@ -9804,29 +10382,29 @@ "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 type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", + "description": "the starting IP of the security group rule", + "name": "startport", "type": "integer" }, { - "description": "the starting IP of the security group rule", - "name": "startport", + "description": "the type of the ICMP message response", + "name": "icmptype", "type": "integer" }, { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", + "description": "the id of the security group rule", + "name": "ruleid", "type": "string" }, { @@ -9839,53 +10417,53 @@ "name": "tags", "response": [ { - "description": "id of the resource", - "name": "resourceid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the 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": "customer associated with the tag", - "name": "customer", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" } ], @@ -9894,8 +10472,56 @@ ], "type": "set" }, - {}, - {} + { + "description": "the name of the security group", + "name": "name", + "type": "string" + }, + { + "description": "the account owning the security group", + "name": "account", + "type": "string" + }, + { + "description": "the project id of the group", + "name": "projectid", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the description of the security group", + "name": "description", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the 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 ID of the security group", + "name": "id", + "type": "string" + }, + { + "description": "the domain ID of the security group", + "name": "domainid", + "type": "string" + } ] }, { @@ -9904,9 +10530,17 @@ "name": "configureOutOfBandManagement", "params": [ { - "description": "the host management interface IP address", + "description": "the ID of the host", "length": 255, - "name": "address", + "name": "hostid", + "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost", + "required": true, + "type": "uuid" + }, + { + "description": "the host management interface user", + "length": 255, + "name": "username", "required": true, "type": "string" }, @@ -9918,9 +10552,9 @@ "type": "string" }, { - "description": "the host management interface user", + "description": "the host management interface password", "length": 255, - "name": "username", + "name": "password", "required": true, "type": "string" }, @@ -9932,36 +10566,19 @@ "type": "string" }, { - "description": "the host management interface password", + "description": "the host management interface IP address", "length": 255, - "name": "password", + "name": "address", "required": true, "type": "string" - }, - { - "description": "the ID of the host", - "length": 255, - "name": "hostid", - "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost,addBaremetalHost,listExternalLoadBalancers", - "required": true, - "type": "uuid" } ], "related": "enableOutOfBandManagementForHost,disableOutOfBandManagementForHost,enableOutOfBandManagementForCluster,disableOutOfBandManagementForCluster,enableOutOfBandManagementForZone,disableOutOfBandManagementForZone,issueOutOfBandManagementPowerAction,changeOutOfBandManagementPassword", "response": [ + {}, { - "description": "the out-of-band management interface username", - "name": "username", - "type": "string" - }, - { - "description": "the out-of-band management driver for the host", - "name": "driver", - "type": "string" - }, - { - "description": "the out-of-band management interface address", - "name": "address", + "description": "the operation result description", + "name": "description", "type": "string" }, { @@ -9970,24 +10587,24 @@ "type": "powerstate" }, { - "description": "the out-of-band management action (if issued)", - "name": "action", + "description": "the out-of-band management interface port", + "name": "port", "type": "string" }, - {}, { - "description": "the out-of-band management interface port", - "name": "port", + "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": "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 out-of-band management action (if issued)", + "name": "action", "type": "string" }, { @@ -10001,20 +10618,29 @@ "type": "string" }, { - "description": "the out-of-band management interface password", - "name": "password", + "description": "the ID of the host", + "name": "hostid", "type": "string" }, { - "description": "the operation result description", - "name": "description", + "description": "the out-of-band management driver for the host", + "name": "driver", "type": "string" }, - {}, { - "description": "true if out-of-band management is enabled for the host", - "name": "enabled", - "type": "boolean" + "description": "the out-of-band management interface username", + "name": "username", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the out-of-band management interface address", + "name": "address", + "type": "string" } ], "since": "4.9.0" @@ -10025,18 +10651,18 @@ "name": "listStorageTags", "params": [ { - "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": "", @@ -10048,33 +10674,33 @@ ], "related": "", "response": [ - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the ID of the storage tag", + "name": "id", "type": "string" }, { - "description": "the pool ID of the storage tag", - "name": "poolid", - "type": "long" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, + {}, { "description": "the name of the storage tag", "name": "name", "type": "string" }, - { - "description": "the ID of the storage tag", - "name": "id", - "type": "string" - }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - {} + { + "description": "the pool ID of the storage tag", + "name": "poolid", + "type": "long" + } ] }, { @@ -10091,18 +10717,7 @@ "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" - }, + "response": [ { "description": "any text associated with the success or failure", "name": "displaytext", @@ -10113,6 +10728,17 @@ "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" + }, {} ] }, @@ -10133,41 +10759,41 @@ "related": "listIsoPermissions,listTemplatePermissions,listIsoPermissions", "response": [ { - "description": "the list of accounts the template is available for", - "name": "account", + "description": "the list of projects the template is available for", + "name": "projectids", "type": "list" }, + {}, { - "description": "the ID of the domain to which the template belongs", - "name": "domainid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "the template ID", "name": "id", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the list of accounts the template is available for", + "name": "account", + "type": "list" + }, + {}, + { + "description": "the ID of the domain to which the template belongs", + "name": "domainid", "type": "string" }, { "description": "true if this template is a public template, false otherwise", "name": "ispublic", "type": "boolean" - }, - { - "description": "the list of projects the template is available for", - "name": "projectids", - "type": "list" - }, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" } ] }, @@ -10188,9 +10814,25 @@ "related": "listSystemVms,migrateSystemVm,startSystemVm,stopSystemVm,changeServiceForSystemVm,scaleSystemVm", "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 UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the private IP address for the system VM", + "name": "privateip", + "type": "string" + }, + {}, + { + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" + }, + { + "description": "the gateway for the system VM", + "name": "gateway", + "type": "string" }, { "description": "the last disconnected date of host", @@ -10198,18 +10840,18 @@ "type": "date" }, { - "description": "the link local netmask for the system vm", - "name": "linklocalnetmask", + "description": "the link local IP address for the system vm", + "name": "linklocalip", "type": "string" }, { - "description": "the Pod name for the system VM", - "name": "podname", + "description": "the link local MAC address for the system vm", + "name": "linklocalmacaddress", "type": "string" }, { - "description": "the public MAC address for the system VM", - "name": "publicmacaddress", + "description": "the ID of the system VM", + "name": "id", "type": "string" }, { @@ -10218,95 +10860,89 @@ "type": "string" }, { - "description": "the host ID for the system VM", - "name": "hostid", - "type": "string" + "description": "public vlan range", + "name": "publicvlan", + "type": "list" }, { - "description": "the private netmask for the system VM", - "name": "privatenetmask", + "description": "the template ID for the system VM", + "name": "templateid", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "guest vlan range", + "name": "guestvlan", + "type": "string" }, { "description": "the state of the system VM", "name": "state", "type": "string" }, - {}, { - "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 gateway for the system VM", - "name": "gateway", + "description": "the first DNS for the system VM", + "name": "dns1", "type": "string" }, { - "description": "the number of active console sessions for the console proxy system vm", - "name": "activeviewersessions", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": "the template ID for the system VM", - "name": "templateid", - "type": "string" - }, - { - "description": "the Pod ID for the system VM", - "name": "podid", + "description": "the host ID for the system VM", + "name": "hostid", "type": "string" }, { - "description": "the link local MAC address for the system vm", - "name": "linklocalmacaddress", + "description": "the systemvm agent version", + "name": "version", "type": "string" }, { - "description": "the link local IP address for the system vm", - "name": "linklocalip", - "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 second DNS for the system VM", - "name": "dns2", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the private IP address for the system VM", - "name": "privateip", + "description": "the link local netmask for the system vm", + "name": "linklocalnetmask", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the name of the system VM", + "name": "name", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the public netmask for the system VM", + "name": "publicnetmask", "type": "string" }, { - "description": "the template name for the system VM", - "name": "templatename", + "description": "the public MAC address for the system VM", + "name": "publicmacaddress", "type": "string" }, { - "description": "the job ID associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job.", - "name": "jobid", + "description": "the Zone name for the system VM", + "name": "zonename", "type": "string" }, - {}, { - "description": "the public netmask for the system VM", - "name": "publicnetmask", + "description": "the second DNS for the system VM", + "name": "dns2", "type": "string" }, { @@ -10315,73 +10951,63 @@ "type": "string" }, { - "description": "the network domain for the system VM", - "name": "networkdomain", + "description": "the agent state of the system VM", + "name": "agentstate", "type": "string" }, { - "description": "the systemvm agent version", - "name": "version", + "description": "the template name for the system VM", + "name": "templatename", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the first DNS for the system VM", - "name": "dns1", + "description": "the private netmask for the system VM", + "name": "privatenetmask", "type": "string" }, - { - "description": "the date and time the system VM was created", - "name": "created", - "type": "date" - }, { "description": "the public IP address for the system VM", "name": "publicip", "type": "string" }, { - "description": "the name of the system VM", - "name": "name", + "description": "the Pod ID for the system VM", + "name": "podid", "type": "string" }, { - "description": "the Zone name for the system VM", - "name": "zonename", + "description": "the Zone ID for the system VM", + "name": "zoneid", "type": "string" }, { - "description": "the Zone ID for the system VM", - "name": "zoneid", + "description": "the private MAC address for the system VM", + "name": "privatemacaddress", "type": "string" }, { - "description": "guest vlan range", - "name": "guestvlan", + "description": "the Pod name for the system VM", + "name": "podname", "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": "the private MAC address for the system VM", - "name": "privatemacaddress", - "type": "string" + "description": "the date and time the system VM was created", + "name": "created", + "type": "date" }, { - "description": "public vlan range", - "name": "publicvlan", - "type": "list" + "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 network domain for the system VM", + "name": "networkdomain", "type": "string" } ] @@ -10392,62 +11018,62 @@ "name": "listAnnotations", "params": [ { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, - { - "description": "the id of the entity for which to show annotations", + "description": "List by keyword", "length": 255, - "name": "entityid", + "name": "keyword", "required": false, "type": "string" }, { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, { - "description": "optional: the id of the user of the annotation", + "description": "the entity type", "length": 255, - "name": "userid", + "name": "entitytype", "required": false, - "since": "4.16.0", "type": "string" }, { - "description": "List by keyword", + "description": "the id of the annotation", "length": 255, - "name": "keyword", + "name": "id", "required": false, "type": "string" }, { - "description": "the entity type", + "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": "entitytype", + "name": "annotationfilter", "required": false, + "since": "4.16.0", "type": "string" }, { - "description": "the id of the annotation", + "description": "optional: the id of the user of the annotation", "length": 255, - "name": "id", + "name": "userid", "required": false, + "since": "4.16.0", "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", + "description": "the id of the entity for which to show annotations", "length": 255, - "name": "annotationfilter", + "name": "entityid", "required": false, - "since": "4.16.0", "type": "string" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" } ], "related": "addAnnotation,removeAnnotation,updateAnnotationVisibility", @@ -10458,8 +11084,13 @@ "type": "date" }, { - "description": "the name of the entitiy to which this annotation pertains", - "name": "entityname", + "description": "the removal timestamp for this annotation", + "name": "removed", + "type": "date" + }, + { + "description": "the contents of the annotation", + "name": "annotation", "type": "string" }, { @@ -10468,51 +11099,46 @@ "type": "string" }, { - "description": "the (uu)id of the annotation", - "name": "id", + "description": "the (uu)id of the entitiy to which this annotation pertains", + "name": "entityid", "type": "string" }, {}, { - "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 (uu)id of the entitiy to which this annotation pertains", - "name": "entityid", - "type": "string" - }, { "description": "the type of the annotated entity", "name": "entitytype", "type": "string" }, { - "description": "The (uu)id of the user that entered the annotation", - "name": "userid", + "description": "the (uu)id of the annotation", + "name": "id", "type": "string" }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "The 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 (uu)id of the user that entered the annotation", + "name": "userid", + "type": "string" }, { - "description": "the contents of the annotation", - "name": "annotation", + "description": "the name of the entitiy to which this annotation pertains", + "name": "entityname", "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ], "since": "4.11" @@ -10523,9 +11149,9 @@ "name": "addSwift", "params": [ { - "description": "the account for swift", + "description": "the username for swift", "length": 255, - "name": "account", + "name": "username", "required": false, "type": "string" }, @@ -10537,51 +11163,56 @@ "type": "string" }, { - "description": "the URL for swift", + "description": "the account for swift", "length": 255, - "name": "url", - "required": true, + "name": "account", + "required": false, "type": "string" }, { - "description": "the username for swift", + "description": "the URL for swift", "length": 255, - "name": "username", - "required": false, + "name": "url", + "required": true, "type": "string" } ], "related": "addSecondaryStorage,listSwifts,updateImageStore,addImageStore,addImageStoreS3,listImageStores,createSecondaryStagingStore,listSecondaryStagingStores,updateCloudToUseObjectStore", "response": [ { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the total disk size of the host", + "name": "disksizetotal", + "type": "long" }, { - "description": "the ID of the image store", - "name": "id", - "type": "string" + "description": "the host's currently used disk size", + "name": "disksizeused", + "type": "long" }, + {}, { - "description": "the scope of the image store", - "name": "scope", - "type": "scopetype" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the Zone name of the image store", - "name": "zonename", + "description": "the ID of the image store", + "name": "id", "type": "string" }, - {}, { "description": "the protocol of the image store", "name": "protocol", "type": "string" }, { - "description": "the url of the image store", - "name": "url", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the Zone ID of the image store", + "name": "zoneid", "type": "string" }, { @@ -10590,40 +11221,35 @@ "type": "boolean" }, { - "description": "the provider name of the image store", - "name": "providername", + "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 Zone ID of the image store", - "name": "zoneid", + "description": "the Zone name of the image store", + "name": "zonename", "type": "string" }, + {}, { "description": "the name of the image store", "name": "name", "type": "string" }, - { - "description": "the 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 total disk size of the host", - "name": "disksizetotal", - "type": "long" + "description": "the provider name of the image store", + "name": "providername", + "type": "string" + }, + { + "description": "the scope of the image store", + "name": "scope", + "type": "scopetype" } ], "since": "3.0.0" @@ -10633,13 +11259,6 @@ "isasync": false, "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\")", - "length": 255, - "name": "startdate", - "required": false, - "type": "date" - }, { "description": "the IDs of the events", "length": 255, @@ -10649,9 +11268,9 @@ "type": "list" }, { - "description": "end date range to archive events (including) this date (use format \"yyyy-MM-dd\" or the new format \"yyyy-MM-ddThh:mm:ss\")", + "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" }, @@ -10661,30 +11280,37 @@ "name": "type", "required": false, "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\")", + "length": 255, + "name": "enddate", + "required": false, + "type": "date" } ], "response": [ - {}, - {}, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, + {}, + {}, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" } ] }, @@ -10704,26 +11330,26 @@ ], "response": [ {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, {}, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" + }, + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" } ], "since": "4.2.0" @@ -10733,6 +11359,14 @@ "isasync": true, "name": "addSrxFirewall", "params": [ + { + "description": "the Physical Network ID", + "length": 255, + "name": "physicalnetworkid", + "related": "createPhysicalNetwork,listPhysicalNetworks,updatePhysicalNetwork", + "required": true, + "type": "uuid" + }, { "description": "Credentials to reach SRX firewall device", "length": 255, @@ -10741,9 +11375,9 @@ "type": "string" }, { - "description": "URL of the SRX appliance.", + "description": "supports only JuniperSRXFirewall", "length": 255, - "name": "url", + "name": "networkdevicetype", "required": true, "type": "string" }, @@ -10755,31 +11389,29 @@ "type": "string" }, { - "description": "supports only JuniperSRXFirewall", + "description": "URL of the SRX appliance.", "length": 255, - "name": "networkdevicetype", + "name": "url", "required": true, "type": "string" - }, - { - "description": "the Physical Network ID", - "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork,listPhysicalNetworks,updatePhysicalNetwork", - "required": true, - "type": "uuid" } ], "related": "configureSrxFirewall", "response": [ { - "description": "the management IP address of the external firewall", - "name": "ipaddress", + "description": "the username that's used to log in to the external firewall", + "name": "username", "type": "string" }, { - "description": "the timeout (in seconds) for requests to the external firewall", - "name": "timeout", + "description": "device name", + "name": "fwdevicename", + "type": "string" + }, + {}, + { + "description": "name of the provider", + "name": "provider", "type": "string" }, { @@ -10787,35 +11419,39 @@ "name": "publiczone", "type": "string" }, + { + "description": "the zone ID of the external firewall", + "name": "zoneid", + "type": "string" + }, { "description": "device capacity", "name": "fwdevicecapacity", "type": "long" }, { - "description": "device id of the SRX firewall", - "name": "fwdeviceid", + "description": "the private interface of the external firewall", + "name": "privateinterface", "type": "string" }, - {}, { - "description": "the username that's used to log in to the external firewall", - "name": "username", + "description": "device state", + "name": "fwdevicestate", "type": "string" }, { - "description": "the physical network to which this SRX firewall belongs to", - "name": "physicalnetworkid", + "description": "the private security zone of the external firewall", + "name": "privatezone", "type": "string" }, { - "description": "the private security zone of the external firewall", - "name": "privatezone", + "description": "the management IP address of the external firewall", + "name": "ipaddress", "type": "string" }, { - "description": "the usage interface of the external firewall", - "name": "usageinterface", + "description": "the physical network to which this SRX firewall belongs to", + "name": "physicalnetworkid", "type": "string" }, { @@ -10824,18 +11460,14 @@ "type": "string" }, { - "description": "device name", - "name": "fwdevicename", - "type": "string" - }, - { - "description": "device state", - "name": "fwdevicestate", + "description": "the timeout (in seconds) for requests to the external firewall", + "name": "timeout", "type": "string" }, + {}, { - "description": "the number of times to retry requests to the external firewall", - "name": "numretries", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -10843,25 +11475,19 @@ "name": "jobstatus", "type": "integer" }, - {}, - { - "description": "the private interface of the external firewall", - "name": "privateinterface", - "type": "string" - }, { - "description": "the zone ID of the external firewall", - "name": "zoneid", + "description": "device id of the SRX firewall", + "name": "fwdeviceid", "type": "string" }, { - "description": "name of the provider", - "name": "provider", + "description": "the number of times to retry requests to the external firewall", + "name": "numretries", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the usage interface of the external firewall", + "name": "usageinterface", "type": "string" } ] @@ -10871,14 +11497,6 @@ "isasync": true, "name": "updateLoadBalancer", "params": [ - { - "description": "the ID of the load balancer", - "length": 255, - "name": "id", - "related": "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, @@ -10887,6 +11505,14 @@ "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" + }, { "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", "length": 255, @@ -10898,30 +11524,10 @@ ], "related": "createLoadBalancer,listLoadBalancers", "response": [ - { - "description": "is rule for display to the regular user", - "name": "fordisplay", - "type": "boolean" - }, - { - "description": "Load Balancer network id", - "name": "networkid", - "type": "string" - }, - { - "description": "the name of the Load Balancer", - "name": "name", - "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", @@ -10931,62 +11537,21 @@ "description": "instance port of the load balancer rule", "name": "instanceport", "type": "integer" - } - ], - "type": "list" - }, - { - "description": "the domain ID of the Load Balancer", - "name": "domainid", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the list of instances associated with the Load Balancer", - "name": "loadbalancerinstance", - "response": [ - { - "description": "the instance ID", - "name": "id", - "type": "string" - }, - { - "description": "the ip address of the instance", - "name": "ipaddress", - "type": "string" }, { - "description": "the state of the instance", + "description": "the state of the load balancer rule", "name": "state", "type": "string" - }, - { - "description": "the name of the instance", - "name": "name", - "type": "string" } ], "type": "list" }, { - "description": "Load Balancer source ip network id", - "name": "sourceipaddressnetworkid", - "type": "string" - }, - { - "description": "the description of the Load Balancer", - "name": "description", - "type": "string" - }, - { - "description": "the project name of the Load Balancer", - "name": "project", + "description": "the Load Balancer ID", + "name": "id", "type": "string" }, + {}, { "description": "the list of resource tags associated with the Load Balancer", "name": "tags", @@ -10997,38 +11562,38 @@ "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 ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { @@ -11037,37 +11602,41 @@ "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the account associated with the tag", + "name": "account", "type": "string" } ], "type": "list" }, { - "description": "the domain of the Load Balancer", - "name": "domain", + "description": "the project name of the Load Balancer", + "name": "project", "type": "string" }, { - "description": "the Load Balancer ID", - "name": "id", + "description": "the description of the Load Balancer", + "name": "description", "type": "string" }, - {}, { - "description": "the load balancer algorithm (source, roundrobin, leastconn)", - "name": "algorithm", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "Load Balancer source ip", - "name": "sourceipaddress", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the domain ID of the Load Balancer", + "name": "domainid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the name of the Load Balancer", + "name": "name", "type": "string" }, { @@ -11075,11 +11644,68 @@ "name": "account", "type": "string" }, + { + "description": "Load Balancer network id", + "name": "networkid", + "type": "string" + }, + { + "description": "the list of instances associated with the Load Balancer", + "name": "loadbalancerinstance", + "response": [ + { + "description": "the instance ID", + "name": "id", + "type": "string" + }, + { + "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" + } + ], + "type": "list" + }, + { + "description": "the domain of the Load Balancer", + "name": "domain", + "type": "string" + }, + { + "description": "is rule for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, + { + "description": "Load Balancer source ip network id", + "name": "sourceipaddressnetworkid", + "type": "string" + }, + { + "description": "Load Balancer source ip", + "name": "sourceipaddress", + "type": "string" + }, { "description": "the project id of the Load Balancer", "name": "projectid", "type": "string" }, + { + "description": "the load balancer algorithm (source, roundrobin, leastconn)", + "name": "algorithm", + "type": "string" + }, {} ], "since": "4.4.0" @@ -11089,6 +11715,13 @@ "isasync": true, "name": "scaleSystemVm", "params": [ + { + "description": "name value pairs of custom parameters for cpu, memory and cpunumber. example details[i].name=value", + "length": 255, + "name": "details", + "required": false, + "type": "map" + }, { "description": "the service offering ID to apply to the system vm", "length": 255, @@ -11104,87 +11737,63 @@ "related": "listSystemVms,migrateSystemVm,startSystemVm,stopSystemVm,changeServiceForSystemVm,scaleSystemVm", "required": true, "type": "uuid" - }, - { - "description": "name value pairs of custom parameters for cpu, memory and cpunumber. example details[i].name=value", - "length": 255, - "name": "details", - "required": false, - "type": "map" } ], "related": "listSystemVms,migrateSystemVm,startSystemVm,stopSystemVm,changeServiceForSystemVm", "response": [ { - "description": "the Zone ID for the system VM", - "name": "zoneid", - "type": "string" - }, - { - "description": "the private IP address for the system VM", - "name": "privateip", - "type": "string" - }, - {}, - { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", - "type": "boolean" - }, - { - "description": "guest vlan range", - "name": "guestvlan", - "type": "string" + "description": "the last disconnected date of host", + "name": "disconnected", + "type": "date" }, { - "description": "the private netmask for the system VM", - "name": "privatenetmask", - "type": "string" + "description": "public vlan range", + "name": "publicvlan", + "type": "list" }, { - "description": "the agent state of the system VM", - "name": "agentstate", + "description": "the template ID for the system VM", + "name": "templateid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the public IP address for the system VM", + "name": "publicip", "type": "string" }, { - "description": "the network domain for the system VM", - "name": "networkdomain", + "description": "the link local IP address for the system vm", + "name": "linklocalip", "type": "string" }, { - "description": "the ID of the system VM", - "name": "id", + "description": "the host ID for the system VM", + "name": "hostid", "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 gateway for the system VM", + "name": "gateway", "type": "string" }, { - "description": "the link local netmask for the system vm", - "name": "linklocalnetmask", + "description": "the public netmask for the system VM", + "name": "publicnetmask", "type": "string" }, { - "description": "the gateway for the system VM", - "name": "gateway", - "type": "string" + "description": "the number of active console sessions for the console proxy system vm", + "name": "activeviewersessions", + "type": "integer" }, - {}, { "description": "the Pod name for the system VM", "name": "podname", "type": "string" }, { - "description": "the public IP address for the system VM", - "name": "publicip", + "description": "the Pod ID for the system VM", + "name": "podid", "type": "string" }, { @@ -11193,8 +11802,13 @@ "type": "string" }, { - "description": "the name of the system VM", - "name": "name", + "description": "the systemvm agent version", + "name": "version", + "type": "string" + }, + { + "description": "the system VM type", + "name": "systemvmtype", "type": "string" }, { @@ -11203,113 +11817,125 @@ "type": "integer" }, { - "description": "the hostname for the system VM", - "name": "hostname", + "description": "the ID of the system VM", + "name": "id", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the date and time the system VM was created", + "name": "created", + "type": "date" }, { - "description": "the Zone name for the system VM", - "name": "zonename", + "description": "the link local netmask for the system vm", + "name": "linklocalnetmask", "type": "string" }, { - "description": "the private MAC address for the system VM", - "name": "privatemacaddress", + "description": "the first DNS for the system VM", + "name": "dns1", "type": "string" }, { - "description": "the first DNS for the system VM", - "name": "dns1", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the number of active console sessions for the console proxy system vm", - "name": "activeviewersessions", - "type": "integer" + "description": "the second DNS for the system VM", + "name": "dns2", + "type": "string" }, { - "description": "the template name for the system VM", - "name": "templatename", + "description": "the agent state of the system VM", + "name": "agentstate", "type": "string" }, { - "description": "the systemvm agent version", - "name": "version", + "description": "the private netmask for the system VM", + "name": "privatenetmask", "type": "string" }, { - "description": "the template ID for the system VM", - "name": "templateid", + "description": "the template name for the system VM", + "name": "templatename", "type": "string" }, { - "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 link local IP address for the system vm", - "name": "linklocalip", + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" + }, + {}, + { + "description": "the state of the system VM", + "name": "state", "type": "string" }, { - "description": "the system VM type", - "name": "systemvmtype", + "description": "the private IP address for the system VM", + "name": "privateip", "type": "string" }, { - "description": "the Pod ID for the system VM", - "name": "podid", + "description": "guest vlan range", + "name": "guestvlan", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the name of the system VM", + "name": "name", "type": "string" }, { - "description": "the host ID for the system VM", - "name": "hostid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the public netmask for the system VM", - "name": "publicnetmask", + "description": "the job ID associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job.", + "name": "jobid", "type": "string" }, { - "description": "the public MAC address for the system VM", - "name": "publicmacaddress", + "description": "the Zone ID for the system VM", + "name": "zoneid", "type": "string" }, { - "description": "the job status associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job.", - "name": "jobstatus", - "type": "integer" + "description": "the hostname for the system VM", + "name": "hostname", + "type": "string" }, + {}, { - "description": "public vlan range", - "name": "publicvlan", - "type": "list" + "description": "the network domain for the system VM", + "name": "networkdomain", + "type": "string" }, { - "description": "the state of the system VM", - "name": "state", + "description": "the private MAC address for the system VM", + "name": "privatemacaddress", "type": "string" }, { - "description": "the date and time the system VM was created", - "name": "created", - "type": "date" + "description": "the 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 second DNS for the system VM", - "name": "dns2", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the Zone name for the system VM", + "name": "zonename", "type": "string" } ] @@ -11323,132 +11949,138 @@ "description": "the ID of the disk volume", "length": 255, "name": "volumeid", - "related": "attachVolume,createVolume,updateVolume,detachVolume,listVolumes,migrateVolume,resizeVolume,destroyVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", + "related": "attachVolume,createVolume,updateVolume,detachVolume,listVolumes,migrateVolume,resizeVolume,destroyVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", "required": false, "type": "uuid" }, { - "description": "the ID of the snapshot policy", + "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", "length": 255, - "name": "id", - "related": "createSnapshotPolicy,updateSnapshotPolicy,listSnapshotPolicies", + "name": "fordisplay", "required": false, - "type": "uuid" + "since": "4.4", + "type": "boolean" }, { - "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": "page", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "description": "the ID of the snapshot policy", "length": 255, - "name": "fordisplay", + "name": "id", + "related": "createSnapshotPolicy,updateSnapshotPolicy,listSnapshotPolicies", "required": false, - "since": "4.4", - "type": "boolean" + "type": "uuid" }, { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" } ], "related": "createSnapshotPolicy,updateSnapshotPolicy", "response": [ + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, { "description": "true if the entity/resource has annotations", "name": "hasannotations", "type": "boolean" }, + {}, + {}, + { + "description": "the 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 domain associated with the tag", - "name": "domain", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "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": "id of the resource", - "name": "resourceid", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" } ], "type": "set" }, { - "description": "the ID of the snapshot policy", - "name": "id", + "description": "time the snapshot is scheduled to be taken.", + "name": "schedule", "type": "string" }, { - "description": "maximum number of snapshots retained", - "name": "maxsnaps", - "type": "int" - }, - {}, - { - "description": "time the snapshot is scheduled to be taken.", - "name": "schedule", + "description": "the time zone of the snapshot policy", + "name": "timezone", "type": "string" }, { - "description": "is this policy for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "the ID of the disk volume", + "name": "volumeid", + "type": "string" }, { "description": "the interval type of the snapshot policy", @@ -11456,26 +12088,20 @@ "type": "short" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the ID of the disk volume", - "name": "volumeid", + "description": "the ID of the snapshot policy", + "name": "id", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "maximum number of snapshots retained", + "name": "maxsnaps", + "type": "int" }, { - "description": "the time zone of the snapshot policy", - "name": "timezone", - "type": "string" - }, - {} + "description": "is this policy for display to the regular user", + "name": "fordisplay", + "type": "boolean" + } ] }, { @@ -11484,171 +12110,167 @@ "name": "updateVpnCustomerGateway", "params": [ { - "description": "ESP policy of the customer gateway", + "description": "Lifetime of phase 2 VPN connection to the customer gateway, in seconds", "length": 255, - "name": "esppolicy", - "required": true, - "type": "string" + "name": "esplifetime", + "required": false, + "type": "long" }, { - "description": "Force encapsulation for Nat Traversal", + "description": "Lifetime of phase 1 VPN connection to the customer gateway, in seconds", "length": 255, - "name": "forceencap", + "name": "ikelifetime", "required": false, - "type": "boolean" + "type": "long" }, { - "description": "name of this customer gateway", + "description": "guest cidr of the customer gateway. Multiple entries must be separated by a single comma character (,).", "length": 255, - "name": "name", - "required": false, + "name": "cidrlist", + "required": true, "type": "string" }, { - "description": "For IKEv2, whether to split multiple right subnet cidrs into multiple connection statements.", + "description": "public ip address id of the customer gateway", "length": 255, - "name": "splitconnections", - "required": false, - "since": "4.15.1", - "type": "boolean" + "name": "gateway", + "required": true, + "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.", + "description": "id of customer gateway", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", - "required": false, + "name": "id", + "related": "createVpnCustomerGateway,listVpnCustomerGateways,updateVpnCustomerGateway", + "required": true, "type": "uuid" }, { - "description": "guest cidr of the customer gateway. Multiple entries must be separated by a single comma character (,).", + "description": "IPsec Preshared-Key of the customer gateway. Cannot contain newline or double quotes.", "length": 255, - "name": "cidrlist", + "name": "ipsecpsk", "required": true, "type": "string" }, { - "description": "Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2.Connections marked with 'ike' will use 'ikev2' when initiating, but accept any protocol version when responding. Defaults to ike", + "description": "name of this customer gateway", "length": 255, - "name": "ikeversion", + "name": "name", "required": false, - "since": "4.15.1", "type": "string" }, { - "description": "Lifetime of phase 1 VPN connection to the customer gateway, in seconds", + "description": "the account associated with the gateway. Must be used with the domainId parameter.", "length": 255, - "name": "ikelifetime", + "name": "account", "required": false, - "type": "long" + "type": "string" }, { - "description": "Lifetime of phase 2 VPN connection to the customer gateway, in seconds", + "description": "If DPD is enabled for VPN connection", "length": 255, - "name": "esplifetime", + "name": "dpd", "required": false, - "type": "long" + "type": "boolean" }, { - "description": "id of customer gateway", + "description": "Force encapsulation for Nat Traversal", "length": 255, - "name": "id", - "related": "createVpnCustomerGateway,listVpnCustomerGateways,updateVpnCustomerGateway", - "required": true, - "type": "uuid" + "name": "forceencap", + "required": false, + "type": "boolean" }, { - "description": "IPsec Preshared-Key of the customer gateway. Cannot contain newline or double quotes.", + "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": "ipsecpsk", - "required": true, - "type": "string" + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", + "required": false, + "type": "uuid" }, { - "description": "IKE policy of the customer gateway", + "description": "ESP policy of the customer gateway", "length": 255, - "name": "ikepolicy", + "name": "esppolicy", "required": true, "type": "string" }, { - "description": "public ip address id of the customer gateway", + "description": "For IKEv2, whether to split multiple right subnet cidrs into multiple connection statements.", "length": 255, - "name": "gateway", - "required": true, - "type": "string" + "name": "splitconnections", + "required": false, + "since": "4.15.1", + "type": "boolean" }, { - "description": "If DPD is enabled for VPN connection", + "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": "dpd", + "name": "ikeversion", "required": false, - "type": "boolean" + "since": "4.15.1", + "type": "string" }, { - "description": "the account associated with the gateway. Must be used with the domainId parameter.", + "description": "IKE policy of the customer gateway", "length": 255, - "name": "account", - "required": false, + "name": "ikepolicy", + "required": true, "type": "string" } ], "related": "createVpnCustomerGateway,listVpnCustomerGateways", "response": [ { - "description": "the vpn gateway ID", - "name": "id", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, + {}, { - "description": "the owner", - "name": "account", + "description": "Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Defaults to ike", + "name": "ikeversion", "type": "string" }, { - "description": "the date and time the host was removed", - "name": "removed", - "type": "date" - }, - { - "description": "public ip address id of the customer gateway", - "name": "gateway", + "description": "the project name", + "name": "project", "type": "string" }, { - "description": "IPsec policy of customer gateway", - "name": "esppolicy", + "description": "the project id", + "name": "projectid", "type": "string" }, { - "description": "Lifetime of IKE SA of customer gateway", - "name": "ikelifetime", - "type": "long" + "description": "For IKEv2, whether to split multiple right subnet cidrs into multiple connection statements.", + "name": "splitconnections", + "type": "boolean" }, { - "description": "IKE policy of customer gateway", - "name": "ikepolicy", + "description": "the owner", + "name": "account", "type": "string" }, { - "description": "if Force NAT Encapsulation is enabled for customer gateway", - "name": "forceencap", - "type": "boolean" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "name of the customer gateway", - "name": "name", + "description": "guest ip of the customer gateway", + "name": "ipaddress", "type": "string" }, { - "description": "For IKEv2, whether to split multiple right subnet cidrs into multiple connection statements.", - "name": "splitconnections", - "type": "boolean" + "description": "guest cidr list of the customer gateway. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", + "type": "string" }, { - "description": "the domain name of the owner", - "name": "domain", - "type": "string" + "description": "Lifetime of IKE SA of customer gateway", + "name": "ikelifetime", + "type": "long" }, { "description": "IPsec preshared-key of customer gateway", @@ -11656,18 +12278,24 @@ "type": "string" }, { - "description": "guest cidr list of the customer gateway. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", + "description": "the domain id of the owner", + "name": "domainid", "type": "string" }, { - "description": "the project id", - "name": "projectid", + "description": "if Force NAT Encapsulation is enabled for customer gateway", + "name": "forceencap", + "type": "boolean" + }, + {}, + { + "description": "the domain name of the owner", + "name": "domain", "type": "string" }, { - "description": "the domain id of the owner", - "name": "domainid", + "description": "IPsec policy of customer gateway", + "name": "esppolicy", "type": "string" }, { @@ -11676,41 +12304,39 @@ "type": "long" }, { - "description": "if DPD is enabled for customer gateway", - "name": "dpd", - "type": "boolean" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "public ip address id of the customer gateway", + "name": "gateway", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the vpn gateway ID", + "name": "id", "type": "string" }, { - "description": "guest ip of the customer gateway", - "name": "ipaddress", + "description": "name of the customer gateway", + "name": "name", "type": "string" }, - {}, - {}, { - "description": "Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Defaults to ike", - "name": "ikeversion", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the project name", - "name": "project", + "description": "IKE policy of customer gateway", + "name": "ikepolicy", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "if DPD is enabled for customer gateway", + "name": "dpd", "type": "boolean" + }, + { + "description": "the date and time the host was removed", + "name": "removed", + "type": "date" } ] }, @@ -11738,200 +12364,185 @@ "related": "createAccount,disableAccount,enableAccount,updateAccount,markDefaultZoneForAccount,listAccounts,listAccounts", "response": [ { - "description": "the network domain", - "name": "networkdomain", - "type": "string" + "description": "the total number of vpcs owned by account", + "name": "vpctotal", + "type": "long" }, { - "description": "the total number of 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": "the total number of vpcs available to be created for this account", - "name": "vpcavailable", - "type": "string" + "description": "the total number of virtual machines deployed by this account", + "name": "vmtotal", + "type": "long" }, - {}, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" + "description": "the total number of snapshots which can be stored by this account", + "name": "snapshotlimit", + "type": "string" }, { "description": "the list of acl groups that account belongs to", "name": "groups", "type": "list" }, + {}, { - "description": "the total number of virtual machines available for this account to acquire", - "name": "vmavailable", - "type": "string" + "description": "the total primary storage space (in GiB) owned by account", + "name": "primarystoragetotal", + "type": "long" }, - {}, { - "description": "the total number of networks the account can own", - "name": "networklimit", + "description": "name of the Domain the account belongs to", + "name": "domain", "type": "string" }, { - "description": "the default zone of the account", - "name": "defaultzoneid", + "description": "the network domain", + "name": "networkdomain", "type": "string" }, { - "description": "the total volume which can be used by this account", - "name": "volumelimit", - "type": "string" + "description": "the total number of networks owned by account", + "name": "networktotal", + "type": "long" }, { - "description": "the total number of cpu cores available to be created for this account", - "name": "cpuavailable", + "description": "the total number of public ip addresses available for this account to acquire", + "name": "ipavailable", "type": "string" }, { - "description": "the total number of public ip addresses this account can acquire", - "name": "iplimit", - "type": "string" + "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 volume available for this account", + "name": "volumeavailable", + "type": "string" }, { - "description": "the total number of networks owned by account", - "name": "networktotal", - "type": "long" + "description": "the total number of cpu cores the account can own", + "name": "cpulimit", + "type": "string" }, { - "description": "the total number of projects the account can own", - "name": "projectlimit", + "description": "the total number of projects available for administration by this account", + "name": "projectavailable", "type": "string" }, { - "description": "the total number of templates which have been created by this account", - "name": "templatetotal", + "description": "the total memory (in MB) owned by account", + "name": "memorytotal", "type": "long" }, { - "description": "the total number of cpu cores the account can own", - "name": "cpulimit", + "description": "the total secondary storage space (in GiB) owned by account", + "name": "secondarystoragetotal", + "type": "float" + }, + { + "description": "the total number of vpcs available to be created for this account", + "name": "vpcavailable", "type": "string" }, { - "description": "the total number of cpu cores owned by account", - "name": "cputotal", - "type": "long" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the name of the role", - "name": "rolename", + "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", + "description": "the id of the account", + "name": "id", "type": "string" }, { - "description": "the total number of snapshots available for this account", - "name": "snapshotavailable", + "description": "the total number of vpcs the account can own", + "name": "vpclimit", "type": "string" }, { - "description": "the total volume being used by this account", - "name": "volumetotal", - "type": "long" + "description": "account type (admin, domain-admin, user)", + "name": "accounttype", + "type": "integer" }, { - "description": "true if account is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "the total number of snapshots stored by this account", + "name": "snapshottotal", + "type": "long" }, { - "description": "the total number of virtual machines stopped for this account", - "name": "vmstopped", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": "the total number of templates available to be created by this account", - "name": "templateavailable", + "description": "the total number of networks the account can own", + "name": "networklimit", "type": "string" }, - { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, { "description": "the name of the account", "name": "name", "type": "string" }, { - "description": "true if the account requires cleanup", - "name": "iscleanuprequired", - "type": "boolean" - }, - { - "description": "the total number of public ip addresses allocated for this account", - "name": "iptotal", - "type": "long" - }, - { - "description": "id of the Domain the account belongs to", - "name": "domainid", - "type": "string" + "description": "the date when this account was created", + "name": "created", + "type": "date" }, { - "description": "the state of the account", - "name": "state", - "type": "string" + "description": "true if account is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { "description": "the total secondary storage space (in GiB) the account can own", "name": "secondarystoragelimit", "type": "string" }, + { + "description": "the total number of projects being administrated by this account", + "name": "projecttotal", + "type": "long" + }, { "description": "details for the account", "name": "accountdetails", "type": "map" }, { - "description": "the id of the account", - "name": "id", - "type": "string" - }, - { - "description": "the total number of public ip addresses available for this account to acquire", - "name": "ipavailable", + "description": "the total number of snapshots available for this account", + "name": "snapshotavailable", "type": "string" }, - { - "description": "account type (admin, domain-admin, user)", - "name": "accounttype", - "type": "short" - }, { "description": "the total memory (in MB) the account can own", "name": "memorylimit", "type": "string" }, { - "description": "the total number of snapshots stored by this account", - "name": "snapshottotal", - "type": "long" + "description": "the total number of networks available to be created for this account", + "name": "networkavailable", + "type": "string" }, + {}, { - "description": "the total number of virtual machines deployed by this account", - "name": "vmtotal", - "type": "long" + "description": "the total number of templates which can be created by this account", + "name": "templatelimit", + "type": "string" }, { - "description": "the type of the role (Admin, ResourceAdmin, DomainAdmin, User)", - "name": "roletype", + "description": "the total memory (in MB) available to be created for this account", + "name": "memoryavailable", "type": "string" }, { @@ -11940,69 +12551,74 @@ "type": "string" }, { - "description": "the total primary storage space (in GiB) available to be used for this account", - "name": "primarystorageavailable", + "description": "the type of the role (Admin, ResourceAdmin, DomainAdmin, User)", + "name": "roletype", "type": "string" }, { - "description": "the total number of vpcs the account can own", - "name": "vpclimit", - "type": "string" + "description": "true if the account requires cleanup", + "name": "iscleanuprequired", + "type": "boolean" }, { - "description": "the total number of vpcs owned by account", - "name": "vpctotal", - "type": "long" + "description": "the total number of virtual machines running for this account", + "name": "vmrunning", + "type": "integer" }, { - "description": "the total memory (in MB) available to be created for this account", - "name": "memoryavailable", + "description": "the total volume which can be used by this account", + "name": "volumelimit", "type": "string" }, { - "description": "the total number of virtual machines running for this account", - "name": "vmrunning", + "description": "the total number of virtual machines stopped for this account", + "name": "vmstopped", "type": "integer" }, { - "description": "the total number of templates which can be created by this account", - "name": "templatelimit", + "description": "the total number of virtual machines that can be deployed by this account", + "name": "vmlimit", "type": "string" }, { - "description": "name of the Domain the account belongs to", - "name": "domain", - "type": "string" + "description": "the total number of templates which have been created by this account", + "name": "templatetotal", + "type": "long" }, { - "description": "the total secondary storage space (in GiB) available to be used for this account", - "name": "secondarystorageavailable", + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" + }, + { + "description": "path of the Domain the account belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the total volume available for this account", - "name": "volumeavailable", + "description": "the total primary storage space (in GiB) available to be used for this account", + "name": "primarystorageavailable", "type": "string" }, { - "description": "the total memory (in MB) owned by account", - "name": "memorytotal", - "type": "long" + "description": "the total number of virtual machines available for this account to acquire", + "name": "vmavailable", + "type": "string" }, { - "description": "the total primary storage space (in GiB) owned by account", - "name": "primarystoragetotal", - "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 role", - "name": "roleid", + "description": "the total primary storage space (in GiB) the account can own", + "name": "primarystoragelimit", "type": "string" }, { - "description": "the total secondary storage space (in GiB) owned by account", - "name": "secondarystoragetotal", - "type": "float" + "description": "the total number of cpu cores available to be created for this account", + "name": "cpuavailable", + "type": "string" }, { "description": "the list of users associated with account", @@ -12014,88 +12630,73 @@ "type": "string" }, { - "description": "the domain ID of the user", - "name": "domainid", - "type": "string" - }, - { - "description": "the secret key of the user", - "name": "secretkey", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the user ID", - "name": "id", + "description": "the domain name of the user", + "name": "domain", "type": "string" }, { - "description": "the user name", - "name": "username", + "description": "the account name of the user", + "name": "account", "type": "string" }, - { - "description": "the date and time the user account was created", - "name": "created", - "type": "date" - }, { "description": "the timezone user was created in", "name": "timezone", "type": "string" }, { - "description": "the user firstname", - "name": "firstname", + "description": "the name of the role", + "name": "rolename", "type": "string" }, { - "description": "the domain name of the user", - "name": "domain", + "description": "the account ID of the user", + "name": "accountid", "type": "string" }, { - "description": "the user email address", - "name": "email", + "description": "the source type of the user in lowercase, such as native, ldap, saml2", + "name": "usersource", "type": "string" }, { - "description": "the user state", - "name": "state", + "description": "the ID of the role", + "name": "roleid", "type": "string" }, { - "description": "the account type of the user", - "name": "accounttype", - "type": "short" - }, - { - "description": "the source type of the user in lowercase, such as native, ldap, saml2", - "name": "usersource", + "description": "the domain ID of the user", + "name": "domainid", "type": "string" }, { - "description": "the api key of the user", - "name": "apikey", + "description": "the user name", + "name": "username", "type": "string" }, { - "description": "the boolean value representing if the updating target is in caller's child domain", - "name": "iscallerchilddomain", - "type": "boolean" + "description": "the user firstname", + "name": "firstname", + "type": "string" }, { - "description": "the name of the role", - "name": "rolename", + "description": "the user ID", + "name": "id", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the date and time the user account was created", + "name": "created", + "type": "date" }, { - "description": "the ID of the role", - "name": "roleid", + "description": "the secret key of the user", + "name": "secretkey", "type": "string" }, { @@ -12104,57 +12705,82 @@ "type": "boolean" }, { - "description": "the account name of the user", - "name": "account", + "description": "the user email address", + "name": "email", "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 ID of the user", - "name": "accountid", + "description": "the boolean value representing if the updating target is in caller's child domain", + "name": "iscallerchilddomain", + "type": "boolean" + }, + { + "description": "the user state", + "name": "state", + "type": "string" + }, + { + "description": "the api key of the user", + "name": "apikey", "type": "string" } ], "type": "list" }, { - "description": "the total number of projects available for administration by this account", - "name": "projectavailable", + "description": "the default zone of the account", + "name": "defaultzoneid", "type": "string" }, { - "description": "the total primary storage space (in GiB) the account can own", - "name": "primarystoragelimit", + "description": "the state of the account", + "name": "state", "type": "string" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" + "description": "id of the Domain the account belongs to", + "name": "domainid", + "type": "string" }, { - "description": "the total number of virtual machines that can be deployed by this account", - "name": "vmlimit", + "description": "the total number of projects the account can own", + "name": "projectlimit", "type": "string" }, { - "description": "the date when this account was created", - "name": "created", - "type": "date" + "description": "the name of the role", + "name": "rolename", + "type": "string" }, { - "description": "path of the Domain the account belongs to", - "name": "domainpath", + "description": "the total number of cpu cores owned by account", + "name": "cputotal", + "type": "long" + }, + { + "description": "the total number of templates available to be created by this account", + "name": "templateavailable", "type": "string" }, { - "description": "the total number of projects being administrated by this account", - "name": "projecttotal", + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", "type": "long" + }, + { + "description": "the ID of the role", + "name": "roleid", + "type": "string" } ] }, @@ -12163,6 +12789,13 @@ "isasync": true, "name": "stopRouter", "params": [ + { + "description": "Force stop the VM. The caller knows the VM is stopped.", + "length": 255, + "name": "forced", + "required": false, + "type": "boolean" + }, { "description": "the ID of the router", "length": 255, @@ -12170,75 +12803,236 @@ "related": "destroyRouter,listRouters,rebootRouter,startRouter,stopRouter,changeServiceForRouter,stopInternalLoadBalancerVM,startInternalLoadBalancerVM,listInternalLoadBalancerVMs,stopNetScalerVpx", "required": true, "type": "uuid" - }, - { - "description": "Force stop the VM. The caller knows the VM is stopped.", - "length": 255, - "name": "forced", - "required": false, - "type": "boolean" } ], "related": "destroyRouter,listRouters,rebootRouter,startRouter,changeServiceForRouter,stopInternalLoadBalancerVM,startInternalLoadBalancerVM,listInternalLoadBalancerVMs,stopNetScalerVpx", "response": [ { - "description": "the Pod ID for the router", - "name": "podid", + "description": "the public netmask for the router", + "name": "publicnetmask", "type": "string" }, { - "description": "the list of nics associated with the router", - "name": "nic", + "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 link local IP address for the router", + "name": "linklocalip", + "type": "string" + }, + { + "description": "Last executed health check result for the router", + "name": "healthcheckresults", "response": [ { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", - "type": "string" - }, - { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" + "description": "the date this VPC was created", + "name": "lastupdated", + "type": "date" }, { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" + "description": "the type of the health check - basic or advanced", + "name": "checktype", + "type": "string" }, { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "the name of the health check on the router", + "name": "checkname", "type": "string" }, { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", - "type": "string" + "description": "result of the health check", + "name": "success", + "type": "boolean" }, { - "description": "the type of the nic", - "name": "type", + "description": "detailed response generated on running health check", + "name": "details", "type": "string" + } + ], + "type": "list" + }, + { + "description": "the project id of the ipaddress", + "name": "projectid", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the second DNS for the router", + "name": "dns2", + "type": "string" + }, + { + "description": "the state of redundant virtual router", + "name": "redundantstate", + "type": "string" + }, + { + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", + "type": "string" + }, + { + "description": "the ID of the corresponding public network", + "name": "publicnetworkid", + "type": "string" + }, + { + "description": "the Zone name for the router", + "name": "zonename", + "type": "string" + }, + { + "description": "the date and time the router was created", + "name": "created", + "type": "date" + }, + { + "description": "the public MAC address for the router", + "name": "publicmacaddress", + "type": "string" + }, + { + "description": "the version of scripts", + "name": "scriptsversion", + "type": "string" + }, + { + "description": "the version of the code / software in the router", + "name": "softwareversion", + "type": "string" + }, + { + "description": "the ID of the corresponding guest network", + "name": "guestnetworkid", + "type": "string" + }, + { + "description": "the Zone ID for the router", + "name": "zoneid", + "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the link local netmask for the router", + "name": "linklocalnetmask", + "type": "string" + }, + {}, + { + "description": "the version of template", + "name": "version", + "type": "string" + }, + { + "description": "the ID of the corresponding link local network", + "name": "linklocalnetworkid", + "type": "string" + }, + { + "description": "role of the domain router", + "name": "role", + "type": "string" + }, + { + "description": "the second IPv6 DNS for the router", + "name": "ip6dns2", + "type": "string" + }, + { + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" + }, + { + "description": "the Pod ID for the router", + "name": "podid", + "type": "string" + }, + { + "description": "the name of the corresponding guest network", + "name": "guestnetworkname", + "type": "string" + }, + { + "description": "the template name for the router", + "name": "templatename", + "type": "string" + }, + { + "description": "the project name of the address", + "name": "project", + "type": "string" + }, + { + "description": "the guest netmask for the router", + "name": "guestnetmask", + "type": "string" + }, + { + "description": "the name of the router", + "name": "name", + "type": "string" + }, + { + "description": "the first DNS for the router", + "name": "dns1", + "type": "string" + }, + { + "description": "the link local MAC address for the router", + "name": "linklocalmacaddress", + "type": "string" + }, + { + "description": "the domain associated with the router", + "name": "domain", + "type": "string" + }, + { + "description": "the list of nics associated with the router", + "name": "nic", + "response": [ + { + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" }, { - "description": "the traffic type of the nic", - "name": "traffictype", + "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 Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" }, { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "the type of the nic", + "name": "type", "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", @@ -12246,33 +13040,33 @@ "type": "string" }, { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", + "description": "the name of the corresponding network", + "name": "networkname", "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": "the isolation uri of the nic", - "name": "isolationuri", + "description": "the ID of the nic", + "name": "id", "type": "string" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "the gateway of the nic", + "name": "gateway", "type": "string" }, { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", + "type": "string" }, { - "description": "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" }, { @@ -12281,18 +13075,18 @@ "type": "boolean" }, { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "the ID of the corresponding network", + "name": "networkid", "type": "string" }, { - "description": "the gateway of the nic", - "name": "gateway", + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", "type": "string" }, { @@ -12301,113 +13095,71 @@ "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "the IPv6 address of network", + "name": "ip6address", "type": "string" }, { - "description": "the IPv6 address of network", - "name": "ip6address", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "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" - } - ], - "type": "set" - }, - { - "description": "VPC the router belongs to", - "name": "vpcid", - "type": "string" - }, - { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", - "type": "string" - }, - { - "description": "the guest IP address for the router", - "name": "guestipaddress", - "type": "string" - }, - { - "description": "the public IP address for the router", - "name": "publicip", - "type": "string" - }, - { - "description": "the domain associated with the router", - "name": "domain", - "type": "string" - }, - { - "description": "the version of scripts", - "name": "scriptsversion", - "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": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", + "type": "string" }, { - "description": "the type of the health check - basic or advanced", - "name": "checktype", + "description": "the isolation uri of the nic", + "name": "isolationuri", "type": "string" }, { - "description": "the name of the health check on the router", - "name": "checkname", + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", "type": "string" }, { - "description": "result of the health check", - "name": "success", - "type": "boolean" + "description": "the netmask of the nic", + "name": "netmask", + "type": "string" }, { - "description": "detailed response generated on running health check", - "name": "details", + "description": "the traffic type of the nic", + "name": "traffictype", + "type": "string" + }, + { + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", "type": "string" + }, + { + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" } ], - "type": "list" - }, - { - "description": "the link local IP address for the router", - "name": "linklocalip", - "type": "string" - }, - { - "description": "if this router is an redundant virtual router", - "name": "isredundantrouter", - "type": "boolean" - }, - { - "description": "the date and time the router was created", - "name": "created", - "type": "date" + "type": "set" }, { - "description": "the ID of the corresponding guest network", - "name": "guestnetworkid", + "description": "the first IPv6 DNS for the router", + "name": "ip6dns1", "type": "string" }, { - "description": "the guest MAC address for the router", - "name": "guestmacaddress", + "description": "the template ID for the router", + "name": "templateid", "type": "string" }, { @@ -12416,123 +13168,23 @@ "type": "boolean" }, { - "description": "the template name for the router", - "name": "templatename", - "type": "string" - }, - { - "description": "true if the router template requires upgrader", - "name": "requiresupgrade", - "type": "boolean" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the Zone ID for the router", - "name": "zoneid", - "type": "string" - }, - { - "description": "the name of the router", - "name": "name", - "type": "string" - }, - { - "description": "the second IPv6 DNS for the router", - "name": "ip6dns2", - "type": "string" - }, - { - "description": "the ID of the corresponding link local network", - "name": "linklocalnetworkid", - "type": "string" - }, - { - "description": "the first DNS for the router", - "name": "dns1", - "type": "string" - }, - { - "description": "the link local MAC address for the router", - "name": "linklocalmacaddress", - "type": "string" - }, - { - "description": "the state of redundant virtual router", - "name": "redundantstate", - "type": "string" - }, - { - "description": "the project id of the ipaddress", - "name": "projectid", - "type": "string" - }, - { - "description": "the name of VPC the router belongs to", - "name": "vpcname", - "type": "string" - }, - { - "description": "the domain ID associated with the router", - "name": "domainid", - "type": "string" - }, - { - "description": "the second DNS for the router", - "name": "dns2", - "type": "string" - }, - { - "description": "the Pod name for the router", - "name": "podname", - "type": "string" - }, - { - "description": "the guest netmask for the router", - "name": "guestnetmask", - "type": "string" - }, - { - "description": "the Zone name for the router", - "name": "zonename", - "type": "string" - }, - { - "description": "the template ID for the router", - "name": "templateid", - "type": "string" - }, - { - "description": "the public netmask for the router", - "name": "publicnetmask", - "type": "string" - }, - { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the gateway for the router", + "name": "gateway", "type": "string" }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, { "description": "the account associated with the router", "name": "account", "type": "string" }, { - "description": "the host ID for the router", - "name": "hostid", + "description": "the name of VPC the router belongs to", + "name": "vpcname", "type": "string" }, { - "description": "the public MAC address for the router", - "name": "publicmacaddress", + "description": "the guest IP address for the router", + "name": "guestipaddress", "type": "string" }, { @@ -12540,34 +13192,20 @@ "name": "serviceofferingname", "type": "string" }, - { - "description": "role of the domain router", - "name": "role", - "type": "string" - }, - { - "description": "the first IPv6 DNS for the router", - "name": "ip6dns1", - "type": "string" - }, - { - "description": "the link local netmask for the router", - "name": "linklocalnetmask", - "type": "string" - }, { "description": "the hostname for the router", "name": "hostname", "type": "string" }, + {}, { - "description": "the project name of the address", - "name": "project", + "description": "the network domain for the router", + "name": "networkdomain", "type": "string" }, { - "description": "the gateway for the router", - "name": "gateway", + "description": "the Pod name for the router", + "name": "podname", "type": "string" }, { @@ -12575,31 +13213,34 @@ "name": "state", "type": "state" }, - {}, { - "description": "the network domain for the router", - "name": "networkdomain", + "description": "the host ID for the router", + "name": "hostid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "if this router is an redundant virtual router", + "name": "isredundantrouter", + "type": "boolean" }, - {}, { - "description": "the name of the corresponding guest network", - "name": "guestnetworkname", + "description": "the public IP address for the router", + "name": "publicip", "type": "string" }, { - "description": "the ID of the corresponding public network", - "name": "publicnetworkid", + "description": "true if the router template requires upgrader", + "name": "requiresupgrade", + "type": "boolean" + }, + { + "description": "the guest MAC address for the router", + "name": "guestmacaddress", "type": "string" }, { - "description": "the version of template", - "name": "version", + "description": "the domain ID associated with the router", + "name": "domainid", "type": "string" }, { @@ -12615,84 +13256,84 @@ "name": "listClusters", "params": [ { - "description": "List by keyword", + "description": "lists clusters by allocation state", "length": 255, - "name": "keyword", + "name": "allocationstate", "required": false, "type": "string" }, { - "description": "whether this cluster is managed by cloudstack", + "description": "lists clusters by Zone ID", "length": 255, - "name": "managedstate", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "", + "description": "lists clusters by Pod ID", "length": 255, - "name": "page", + "name": "podid", + "related": "listPods,updatePod,createManagementNetworkIpRange", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "lists clusters by hypervisor type", + "description": "flag to display the capacity of the clusters", "length": 255, - "name": "hypervisor", + "name": "showcapacities", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "lists clusters by Pod ID", + "description": "whether this cluster is managed by cloudstack", "length": 255, - "name": "podid", - "related": "listPods,updatePod,createManagementNetworkIpRange", + "name": "managedstate", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "lists clusters by Zone ID", + "description": "", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "lists clusters by allocation state", + "description": "lists clusters by the cluster ID", "length": 255, - "name": "allocationstate", + "name": "id", + "related": "addCluster,listClusters,updateCluster", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "lists clusters by cluster type", + "description": "List by keyword", "length": 255, - "name": "clustertype", + "name": "keyword", "required": false, "type": "string" }, { - "description": "flag to display the capacity of the clusters", + "description": "", "length": 255, - "name": "showcapacities", + "name": "page", "required": false, - "type": "boolean" + "type": "integer" }, { - "description": "lists clusters by the cluster ID", + "description": "lists clusters by hypervisor type", "length": 255, - "name": "id", - "related": "addCluster,listClusters,updateCluster", + "name": "hypervisor", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "", + "description": "lists clusters by cluster type", "length": 255, - "name": "pagesize", + "name": "clustertype", "required": false, - "type": "integer" + "type": "string" }, { "description": "lists clusters by the cluster name", @@ -12704,64 +13345,25 @@ ], "related": "addCluster,updateCluster", "response": [ - { - "description": "the Pod name of the cluster", - "name": "podname", - "type": "string" - }, + {}, { "description": "true if the entity/resource has annotations", "name": "hasannotations", "type": "boolean" }, { - "description": "The memory overcommit ratio of the cluster", - "name": "memoryovercommitratio", - "type": "string" - }, - { - "description": "whether this cluster is managed by cloudstack", - "name": "managedstate", - "type": "string" - }, - { - "description": "the Pod ID of the cluster", - "name": "podid", - "type": "string" - }, - { - "description": "the type of the cluster", - "name": "clustertype", - "type": "string" - }, - { - "description": "Ovm3 VIP to use for pooling and/or clustering", - "name": "ovm3vip", + "description": "the cluster name", + "name": "name", "type": "string" }, - { - "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 percentage of capacity currently in use", - "name": "percentused", - "type": "string" - }, - { - "description": "the capacity type", - "name": "type", - "type": "short" - }, - { - "description": "the Pod ID", - "name": "podid", - "type": "string" + "description": "the capacity currently in use", + "name": "capacityused", + "type": "long" }, { "description": "the capacity name", @@ -12769,61 +13371,71 @@ "type": "string" }, { - "description": "the Zone name", - "name": "zonename", + "description": "the percentage of capacity currently in use", + "name": "percentused", "type": "string" }, { - "description": "the total capacity available", - "name": "capacitytotal", + "description": "the capacity currently in allocated", + "name": "capacityallocated", "type": "long" }, { - "description": "the Cluster ID", - "name": "clusterid", + "description": "the Zone ID", + "name": "zoneid", "type": "string" }, { - "description": "the capacity currently in use", - "name": "capacityused", - "type": "long" + "description": "the Pod ID", + "name": "podid", + "type": "string" }, { - "description": "the Cluster name", - "name": "clustername", + "description": "the Zone name", + "name": "zonename", "type": "string" }, { - "description": "the Zone ID", - "name": "zoneid", + "description": "the Cluster name", + "name": "clustername", "type": "string" }, { - "description": "the capacity currently in allocated", - "name": "capacityallocated", + "description": "the total capacity available", + "name": "capacitytotal", "type": "long" }, { "description": "the Pod name", "name": "podname", "type": "string" + }, + { + "description": "the Cluster ID", + "name": "clusterid", + "type": "string" + }, + { + "description": "the capacity type", + "name": "type", + "type": "short" } ], "type": "list" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the Zone name of the cluster", + "name": "zonename", "type": "string" }, { - "description": "the Zone ID of the cluster", - "name": "zoneid", + "description": "the Pod name of the cluster", + "name": "podname", "type": "string" }, { - "description": "the cluster ID", - "name": "id", + "description": "the Pod ID of the cluster", + "name": "podid", "type": "string" }, { @@ -12831,21 +13443,45 @@ "name": "cpuovercommitratio", "type": "string" }, - {}, { - "description": "the Zone name of the cluster", - "name": "zonename", + "description": "the cluster ID", + "name": "id", + "type": "string" + }, + { + "description": "the Zone ID of the cluster", + "name": "zoneid", + "type": "string" + }, + { + "description": "Ovm3 VIP to use for pooling and/or clustering", + "name": "ovm3vip", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, {}, + { + "description": "Meta data associated with the zone (key/value pairs)", + "name": "resourcedetails", + "type": "map" + }, + { + "description": "whether this cluster is managed by cloudstack", + "name": "managedstate", + "type": "string" + }, { "description": "the hypervisor type of the cluster", "name": "hypervisortype", "type": "string" }, { - "description": "the cluster name", - "name": "name", + "description": "the type of the cluster", + "name": "clustertype", "type": "string" }, { @@ -12853,6 +13489,11 @@ "name": "allocationstate", "type": "string" }, + { + "description": "The memory overcommit ratio of the cluster", + "name": "memoryovercommitratio", + "type": "string" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", @@ -12880,22 +13521,22 @@ "name": "success", "type": "boolean" }, + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {}, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" }, - {}, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" } ], "since": "3.0.0" @@ -12906,26 +13547,26 @@ "name": "listProjectInvitations", "params": [ { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "listall", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "", + "description": "if true, list only active invitations - having Pending state and ones that are not timed out yet", "length": 255, - "name": "page", + "name": "activeonly", "required": false, - "type": "integer" + "type": "boolean" }, { - "description": "list only resources belonging to the domain specified", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", + "name": "listall", "required": false, - "type": "uuid" + "type": "boolean" }, { "description": "list invitations by id", @@ -12935,6 +13576,13 @@ "required": false, "type": "uuid" }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, { "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, @@ -12942,6 +13590,14 @@ "required": false, "type": "boolean" }, + { + "description": "list by project id", + "length": 255, + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "required": false, + "type": "uuid" + }, { "description": "list invitations by state", "length": 255, @@ -12957,11 +13613,11 @@ "type": "string" }, { - "description": "if true, list only active invitations - having Pending state and ones that are not timed out yet", + "description": "", "length": 255, - "name": "activeonly", + "name": "pagesize", "required": false, - "type": "boolean" + "type": "integer" }, { "description": "List by keyword", @@ -12977,70 +13633,55 @@ "related": "createUser,disableUser,enableUser,getUser,listUsers,lockUser,updateUser", "required": false, "type": "uuid" - }, - { - "description": "list by project id", - "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", - "required": false, - "type": "uuid" - }, - { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" } ], "related": "", "response": [ { - "description": "the email the invitation was sent to", - "name": "email", + "description": "the domain id the project belongs to", + "name": "domainid", "type": "string" }, - {}, - {}, { - "description": "the id of the project", - "name": "projectid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the id of the invitation", - "name": "id", + "description": "the email the invitation was sent to", + "name": "email", "type": "string" }, + {}, { - "description": "the User ID", - "name": "userid", + "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 account name of the project's owner", + "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 project", + "name": "projectid", + "type": "string" }, { - "description": "the name of the project", - "name": "project", + "description": "the User ID", + "name": "userid", "type": "string" }, { - "description": "the domain id the project belongs to", - "name": "domainid", + "description": "the domain name where the project belongs to", + "name": "domain", "type": "string" }, { - "description": "the account name of the project's owner", - "name": "account", + "description": "the name of the project", + "name": "project", "type": "string" }, { @@ -13049,8 +13690,8 @@ "type": "string" }, { - "description": "the domain name where the project belongs to", - "name": "domain", + "description": "the id of the invitation", + "name": "id", "type": "string" } ], @@ -13062,27 +13703,13 @@ "name": "listEgressFirewallRules", "params": [ { - "description": "list objects by project", + "description": "Lists rule with the specified ID.", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "name": "id", + "related": "createIpv6FirewallRule,listIpv6FirewallRules,updateIpv6FirewallRule,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules", "required": false, "type": "uuid" }, - { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", - "length": 255, - "name": "isrecursive", - "required": false, - "type": "boolean" - }, - { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, { "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, @@ -13099,15 +13726,7 @@ "type": "boolean" }, { - "description": "Lists rule with the specified ID.", - "length": 255, - "name": "id", - "related": "createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules", - "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", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller 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, @@ -13120,13 +13739,6 @@ "required": false, "type": "integer" }, - { - "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, @@ -13143,78 +13755,70 @@ "required": false, "type": "uuid" }, - { - "description": "the network ID for the egress firewall services", - "length": 255, - "name": "networkid", - "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listF5LoadBalancerNetworks,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listSrxFirewallNetworks,listBrocadeVcsDeviceNetworks", - "required": false, - "type": "uuid" - }, { "description": "List by keyword", "length": 255, "name": "keyword", "required": false, "type": "string" - } - ], - "related": "createFirewallRule,listFirewallRules,updateEgressFirewallRule", - "response": [ - { - "description": "the protocol of the firewall rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the public ip address id for the firewall rule", - "name": "ipaddressid", - "type": "string" }, { - "description": "the starting port of firewall rule's port range", - "name": "startport", + "description": "", + "length": 255, + "name": "page", + "required": false, "type": "integer" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "list objects by project; if projectid=-1 lists All VMs", + "length": 255, + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "required": false, + "type": "uuid" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "length": 255, + "name": "isrecursive", + "required": false, + "type": "boolean" }, { - "description": "the state of the rule", - "name": "state", - "type": "string" + "description": "List resources by tags (key/value pairs)", + "length": 255, + "name": "tags", + "required": false, + "type": "map" }, + { + "description": "the network ID for the egress firewall services", + "length": 255, + "name": "networkid", + "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listSrxFirewallNetworks,listBrocadeVcsDeviceNetworks", + "required": false, + "type": "uuid" + } + ], + "related": "createFirewallRule,listFirewallRules,updateEgressFirewallRule", + "response": [ { "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 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 list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { @@ -13223,13 +13827,13 @@ "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { @@ -13238,8 +13842,8 @@ "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { @@ -13253,22 +13857,42 @@ "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the account associated with the tag", + "name": "account", "type": "string" } ], "type": "list" }, { - "description": "is rule for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "the ID of the firewall rule", + "name": "id", + "type": "string" + }, + { + "description": "the protocol of the firewall rule", + "name": "protocol", + "type": "string" + }, + { + "description": "the public ip address id for the firewall rule", + "name": "ipaddressid", + "type": "string" + }, + { + "description": "the traffic type for the firewall rule", + "name": "traffictype", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "the network id of the firewall rule", @@ -13276,9 +13900,25 @@ "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 cidr list to forward traffic to. Multiple entries are separated by a single comma character (,).", + "name": "destcidrlist", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + {}, + { + "description": "the state of the rule", + "name": "state", + "type": "string" }, { "description": "the ending port of firewall rule's port range", @@ -13286,14 +13926,20 @@ "type": "integer" }, { - "description": "the cidr list to forward traffic to. Multiple entries are separated by a single comma character (,).", - "name": "destcidrlist", - "type": "string" + "description": "error code for this icmp message", + "name": "icmpcode", + "type": "integer" }, { - "description": "the ID of the firewall rule", - "name": "id", + "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", "type": "string" + }, + {}, + { + "description": "the starting port of firewall rule's port range", + "name": "startport", + "type": "integer" } ] }, @@ -13302,13 +13948,6 @@ "isasync": false, "name": "updateRegion", "params": [ - { - "description": "updates region with this end point", - "length": 255, - "name": "endpoint", - "required": false, - "type": "string" - }, { "description": "updates region with this name", "length": 255, @@ -13322,31 +13961,43 @@ "name": "id", "required": true, "type": "integer" + }, + { + "description": "updates region with this end point", + "length": 255, + "name": "endpoint", + "required": false, + "type": "string" } ], "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 end point of the region", - "name": "endpoint", - "type": "string" + "description": "the ID of the region", + "name": "id", + "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" }, {}, + {}, { - "description": "true if security groups support is enabled, false otherwise", - "name": "portableipserviceenabled", - "type": "boolean" + "description": "the name of the region", + "name": "name", + "type": "string" }, { "description": "the current status of the latest async job acting on this object", @@ -13354,14 +14005,9 @@ "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the ID of the region", - "name": "id", - "type": "integer" + "description": "true if security groups support is enabled, false otherwise", + "name": "portableipserviceenabled", + "type": "boolean" } ] }, @@ -13380,28 +14026,28 @@ } ], "response": [ - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, + {}, + {}, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" }, - {}, - {} + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } ], "since": "3.0.0" }, @@ -13411,62 +14057,62 @@ "name": "listClustersMetrics", "params": [ { - "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": "lists clusters by cluster type", + "description": "lists clusters by the cluster name", "length": 255, - "name": "clustertype", + "name": "name", "required": false, "type": "string" }, { - "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": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { - "description": "lists clusters by the cluster name", + "description": "flag to display the capacity of the clusters", "length": 255, - "name": "name", + "name": "showcapacities", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "whether this cluster is managed by cloudstack", + "description": "List by keyword", "length": 255, - "name": "managedstate", + "name": "keyword", "required": false, "type": "string" }, { - "description": "lists clusters by the cluster ID", + "description": "lists clusters by Zone ID", "length": 255, - "name": "id", - "related": "addCluster,updateCluster", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, "type": "uuid" }, { - "description": "lists clusters by Zone ID", + "description": "lists clusters by cluster type", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "clustertype", "required": false, - "type": "uuid" + "type": "string" }, { "description": "lists clusters by Pod ID", @@ -13484,16 +14130,16 @@ "type": "integer" }, { - "description": "", + "description": "lists clusters by allocation state", "length": 255, - "name": "page", + "name": "allocationstate", "required": false, - "type": "integer" + "type": "string" }, { - "description": "lists clusters by allocation state", + "description": "lists clusters by hypervisor type", "length": 255, - "name": "allocationstate", + "name": "hypervisor", "required": false, "type": "string" } @@ -13501,31 +14147,40 @@ "related": "", "response": [ { - "description": "the total cpu used in Ghz", - "name": "cpuused", + "description": "cpu usage notification threshold exceeded", + "name": "cputhreshold", + "type": "boolean" + }, + { + "description": "the total cpu used in GiB", + "name": "memoryused", "type": "string" }, { - "description": "the type of the cluster", - "name": "clustertype", + "description": "The memory overcommit ratio of the cluster", + "name": "memoryovercommitratio", "type": "string" }, { - "description": "The cpu overcommit ratio of the cluster", - "name": "cpuovercommitratio", + "description": "the total cpu allocated in GiB", + "name": "memoryallocated", "type": "string" }, { - "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 total cpu capacity in Ghz", + "name": "cputotal", "type": "string" }, { - "description": "memory allocated disable threshold exceeded", - "name": "memoryallocateddisablethreshold", + "description": "memory usage notification threshold exceeded", + "name": "memorythreshold", "type": "boolean" }, - {}, { "description": "cpu allocated disable threshold exceeded", "name": "cpuallocateddisablethreshold", @@ -13537,23 +14192,13 @@ "type": "string" }, { - "description": "the total cpu allocated in Ghz", - "name": "cpuallocated", - "type": "string" - }, - { - "description": "the Pod ID of the cluster", - "name": "podid", - "type": "string" - }, - { - "description": "the Zone ID of the cluster", - "name": "zoneid", + "description": "the maximum cpu deviation", + "name": "cpumaxdeviation", "type": "string" }, { - "description": "The memory overcommit ratio of the cluster", - "name": "memoryovercommitratio", + "description": "the total cpu capacity in GiB", + "name": "memorytotal", "type": "string" }, { @@ -13562,94 +14207,80 @@ "type": "string" }, { - "description": "the hypervisor type of the cluster", - "name": "hypervisortype", + "description": "the total cpu used in Ghz", + "name": "cpuused", "type": "string" }, { - "description": "the Zone name of the cluster", - "name": "zonename", + "description": "the cluster name", + "name": "name", "type": "string" }, { - "description": "Ovm3 VIP to use for pooling and/or clustering", - "name": "ovm3vip", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, { - "description": "the total cpu used in GiB", - "name": "memoryused", - "type": "string" + "description": "memory usage disable threshold exceeded", + "name": "memorydisablethreshold", + "type": "boolean" }, { - "description": "state of the cluster", - "name": "state", - "type": "string" + "description": "cpu allocated notification threshold exceeded", + "name": "cpuallocatedthreshold", + "type": "boolean" }, { - "description": "memory usage notification threshold exceeded", - "name": "memorythreshold", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, - {}, { "description": "running / total hosts in the cluster", "name": "hosts", "type": "string" }, { - "description": "the cluster ID", - "name": "id", + "description": "the Zone name of the cluster", + "name": "zonename", "type": "string" }, + {}, { - "description": "the Pod name of the cluster", - "name": "podname", - "type": "string" + "description": "Meta data associated with the zone (key/value pairs)", + "name": "resourcedetails", + "type": "map" }, { - "description": "the cluster name", - "name": "name", + "description": "the hypervisor type of the cluster", + "name": "hypervisortype", "type": "string" }, { - "description": "cpu usage disable threshold exceeded", - "name": "cpudisablethreshold", - "type": "boolean" - }, - { - "description": "cpu usage notification threshold exceeded", - "name": "cputhreshold", - "type": "boolean" - }, - { - "description": "whether this cluster is managed by cloudstack", - "name": "managedstate", + "description": "the Pod ID of the cluster", + "name": "podid", "type": "string" }, - { - "description": "cpu allocated notification threshold exceeded", - "name": "cpuallocatedthreshold", - "type": "boolean" - }, - { - "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 percentage of capacity currently in use", - "name": "percentused", + "description": "the Zone ID", + "name": "zoneid", "type": "string" }, { - "description": "the Cluster ID", - "name": "clusterid", - "type": "string" + "description": "the total capacity available", + "name": "capacitytotal", + "type": "long" }, { "description": "the Zone name", @@ -13657,18 +14288,13 @@ "type": "string" }, { - "description": "the capacity currently in use", - "name": "capacityused", - "type": "long" - }, - { - "description": "the Zone ID", - "name": "zoneid", + "description": "the capacity name", + "name": "name", "type": "string" }, { - "description": "the Cluster name", - "name": "clustername", + "description": "the percentage of capacity currently in use", + "name": "percentused", "type": "string" }, { @@ -13682,24 +14308,29 @@ "type": "short" }, { - "description": "the Pod ID", - "name": "podid", + "description": "the Pod name", + "name": "podname", "type": "string" }, { - "description": "the total capacity available", - "name": "capacitytotal", - "type": "long" + "description": "the Cluster ID", + "name": "clusterid", + "type": "string" }, { - "description": "the capacity name", - "name": "name", + "description": "the Cluster name", + "name": "clustername", "type": "string" }, { - "description": "the Pod name", - "name": "podname", + "description": "the Pod ID", + "name": "podid", "type": "string" + }, + { + "description": "the capacity currently in use", + "name": "capacityused", + "type": "long" } ], "type": "list" @@ -13710,39 +14341,54 @@ "type": "boolean" }, { - "description": "the maximum cpu deviation", - "name": "cpumaxdeviation", + "description": "the Zone ID of the cluster", + "name": "zoneid", + "type": "string" + }, + { + "description": "memory allocated disable threshold exceeded", + "name": "memoryallocateddisablethreshold", + "type": "boolean" + }, + { + "description": "state of the cluster", + "name": "state", + "type": "string" + }, + { + "description": "The cpu overcommit ratio of the cluster", + "name": "cpuovercommitratio", "type": "string" }, { - "description": "the total cpu capacity in Ghz", - "name": "cputotal", + "description": "the cluster ID", + "name": "id", "type": "string" }, { - "description": "the total cpu capacity in GiB", - "name": "memorytotal", + "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 type of the cluster", + "name": "clustertype", + "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the total cpu allocated in Ghz", + "name": "cpuallocated", + "type": "string" }, { - "description": "the total cpu allocated in GiB", - "name": "memoryallocated", + "description": "Ovm3 VIP to use for pooling and/or clustering", + "name": "ovm3vip", "type": "string" }, { - "description": "memory usage disable threshold exceeded", - "name": "memorydisablethreshold", - "type": "boolean" + "description": "whether this cluster is managed by cloudstack", + "name": "managedstate", + "type": "string" } ], "since": "4.9.3" @@ -13771,21 +14417,6 @@ ], "related": "createProjectRolePermission", "response": [ - { - "description": "the api name or wildcard rule", - "name": "rule", - "type": "string" - }, - { - "description": "the permission type of the api name or wildcard rule, allow/deny", - "name": "permission", - "type": "string" - }, - { - "description": "the ID of the project role to which the role permission belongs", - "name": "projectroleid", - "type": "string" - }, { "description": "the name of the project role to which the role permission belongs", "name": "projectrolename", @@ -13796,78 +14427,20 @@ "name": "description", "type": "string" }, - {}, - {}, - { - "description": "the ID of the project", - "name": "projectid", - "type": "string" - }, - { - "description": "the ID of the project role permission", - "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.15.0" - }, - { - "description": "Creates a user-defined VM backup schedule", - "isasync": false, - "name": "createBackupSchedule", - "params": [ - { - "description": "ID of the VM for which schedule is to be defined", - "length": 255, - "name": "virtualmachineid", - "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,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": "Specifies a timezone for this command. For more information on the timezone parameter, see TimeZone Format.", - "length": 255, - "name": "timezone", - "required": true, - "type": "string" - }, - { - "description": "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)", - "length": 255, - "name": "schedule", - "required": true, - "type": "string" - }, - { - "description": "valid values are HOURLY, DAILY, WEEKLY, and MONTHLY", - "length": 255, - "name": "intervaltype", - "required": true, - "type": "string" - } - ], - "related": "updateBackupSchedule,listBackups", - "response": [ - { - "description": "zone name", - "name": "zone", + "description": "the ID of the project", + "name": "projectid", "type": "string" }, - {}, - {}, { - "description": "backup offering id", - "name": "backupofferingid", + "description": "the ID of the project role to which the role permission belongs", + "name": "projectroleid", "type": "string" }, { @@ -13875,93 +14448,24 @@ "name": "jobstatus", "type": "integer" }, + {}, { - "description": "account id", - "name": "accountid", - "type": "string" - }, - { - "description": "ID of the VM backup", + "description": "the ID of the project role permission", "name": "id", "type": "string" }, { - "description": "domain id", - "name": "domainid", - "type": "string" - }, - { - "description": "zone id", - "name": "zoneid", - "type": "string" - }, - { - "description": "backup date", - "name": "created", - "type": "string" - }, - { - "description": "account name", - "name": "account", - "type": "string" - }, - { - "description": "name of the VM", - "name": "virtualmachinename", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "backup status", - "name": "status", - "type": "status" - }, - { - "description": "backup protected (virtual) size in bytes", - "name": "virtualsize", - "type": "long" - }, - { - "description": "backup type", - "name": "type", - "type": "string" - }, - { - "description": "external backup id", - "name": "externalid", - "type": "string" - }, - { - "description": "ID of the VM", - "name": "virtualmachineid", - "type": "string" - }, - { - "description": "domain name", - "name": "domain", - "type": "string" - }, - { - "description": "backup size in bytes", - "name": "size", - "type": "long" - }, - { - "description": "backed up volumes", - "name": "volumes", + "description": "the api name or wildcard rule", + "name": "rule", "type": "string" }, { - "description": "backup offering name", - "name": "backupofferingname", + "description": "the permission type of the api name or wildcard rule, allow/deny", + "name": "permission", "type": "string" } ], - "since": "4.14.0" + "since": "4.15.0" }, { "description": "Lists all LDAP configurations", @@ -13984,11 +14488,11 @@ "type": "string" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "pagesize", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { "description": "Port", @@ -13997,13 +14501,6 @@ "required": false, "type": "integer" }, - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - }, { "description": "If set to true, and no domainid specified, list all LDAP configurations irrespective of the linked domain", "length": 255, @@ -14018,36 +14515,43 @@ "name": "page", "required": false, "type": "integer" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" } ], "related": "addLdapConfiguration,deleteLdapConfiguration", "response": [ {}, - { - "description": "port teh 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" + "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": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" + }, + { + "description": "linked domain", + "name": "domainid", + "type": "string" } ], "since": "4.2.0" @@ -14058,12 +14562,11 @@ "name": "listSecondaryStagingStores", "params": [ { - "description": "the Zone ID for the staging store", + "description": "the staging store protocol", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "protocol", "required": false, - "type": "uuid" + "type": "string" }, { "description": "the name of the staging store", @@ -14073,45 +14576,46 @@ "type": "string" }, { - "description": "", + "description": "the staging store provider", "length": 255, - "name": "page", + "name": "provider", "required": false, - "type": "integer" + "type": "string" }, { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, { - "description": "List by keyword", + "description": "the ID of the staging store", "length": 255, - "name": "keyword", + "name": "id", + "related": "addSecondaryStorage,listSwifts,updateImageStore,addImageStore,addImageStoreS3,listImageStores,createSecondaryStagingStore,listSecondaryStagingStores,updateCloudToUseObjectStore", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "the ID of the staging store", + "description": "the Zone ID for the staging store", "length": 255, - "name": "id", - "related": "addSecondaryStorage,listSwifts,updateImageStore,addImageStore,addImageStoreS3,listImageStores,createSecondaryStagingStore,listSecondaryStagingStores,updateCloudToUseObjectStore", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, "type": "uuid" }, { - "description": "the staging store provider", + "description": "", "length": 255, - "name": "provider", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { - "description": "the staging store protocol", + "description": "List by keyword", "length": 255, - "name": "protocol", + "name": "keyword", "required": false, "type": "string" } @@ -14119,8 +14623,8 @@ "related": "addSecondaryStorage,listSwifts,updateImageStore,addImageStore,addImageStoreS3,listImageStores,createSecondaryStagingStore,updateCloudToUseObjectStore", "response": [ { - "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" }, { @@ -14128,26 +14632,39 @@ "name": "providername", "type": "string" }, + { + "description": "the Zone name of the image store", + "name": "zonename", + "type": "string" + }, { "description": "the host's currently used disk size", "name": "disksizeused", "type": "long" }, - {}, { - "description": "the name of the image store", - "name": "name", + "description": "the ID of the image store", + "name": "id", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "the url of the image store", + "name": "url", + "type": "string" + }, + { + "description": "defines if store is read-only", + "name": "readonly", "type": "boolean" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the protocol of the image store", + "name": "protocol", + "type": "string" + }, + { + "description": "the name of the image store", + "name": "name", "type": "string" }, { @@ -14156,40 +14673,27 @@ "type": "integer" }, { - "description": "the Zone ID of the image store", - "name": "zoneid", - "type": "string" + "description": "the total disk size of the host", + "name": "disksizetotal", + "type": "long" }, { - "description": "defines if store is read-only", - "name": "readonly", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "the Zone name of the image store", - "name": "zonename", + "description": "the Zone ID of the image store", + "name": "zoneid", "type": "string" }, + {}, { "description": "the scope of the image store", "name": "scope", "type": "scopetype" }, - { - "description": "the protocol of the image store", - "name": "protocol", - "type": "string" - }, - { - "description": "the ID of the image store", - "name": "id", - "type": "string" - }, - { - "description": "the total disk size of the host", - "name": "disksizetotal", - "type": "long" - } + {} ], "since": "4.2.0" }, @@ -14199,9 +14703,9 @@ "name": "createRemoteAccessVpn", "params": [ { - "description": "an optional account for the VPN. Must be used with domainId.", + "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": "account", + "name": "iprange", "required": false, "type": "string" }, @@ -14213,14 +14717,6 @@ "since": "4.4", "type": "boolean" }, - { - "description": "public ip address id of the vpn server", - "length": 255, - "name": "publicipid", - "related": "associateIpAddress,listPublicIpAddresses,updateIpAddress,associateIpAddress,listPublicIpAddresses", - "required": true, - "type": "uuid" - }, { "description": "an optional domainId for the VPN. If the account parameter is used, domainId must also be used.", "length": 255, @@ -14237,9 +14733,17 @@ "type": "boolean" }, { - "description": "the range of ip addresses to allocate to vpn clients. The first ip in the range will be taken by the vpn server", + "description": "public ip address id of the vpn server", "length": 255, - "name": "iprange", + "name": "publicipid", + "related": "associateIpAddress,listPublicIpAddresses,updateIpAddress,associateIpAddress,listPublicIpAddresses", + "required": true, + "type": "uuid" + }, + { + "description": "an optional account for the VPN. Must be used with domainId.", + "length": 255, + "name": "account", "required": false, "type": "string" } @@ -14247,43 +14751,39 @@ "related": "listRemoteAccessVpns,updateRemoteAccessVpn", "response": [ { - "description": "the project name of the vpn", - "name": "project", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the domain name of the account of the remote access vpn", - "name": "domain", + "description": "the state of the rule", + "name": "state", "type": "string" }, + {}, { - "description": "the range of ips to allocate to the clients", - "name": "iprange", - "type": "string" + "description": "is vpn for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, { - "description": "the domain id of the account of the remote access vpn", - "name": "domainid", + "description": "the domain name of the account of the remote access vpn", + "name": "domain", "type": "string" }, { - "description": "is vpn for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "the public ip address of the vpn server", + "name": "publicipid", + "type": "string" }, { - "description": "the state of the rule", - "name": "state", + "description": "the project name of the vpn", + "name": "project", "type": "string" }, { - "description": "the public ip address of the vpn server", - "name": "publicip", + "description": "the ipsec preshared key", + "name": "presharedkey", "type": "string" }, { @@ -14292,32 +14792,36 @@ "type": "string" }, { - "description": "the public ip address of the vpn server", - "name": "publicipid", + "description": "the domain id of the account of the remote access vpn", + "name": "domainid", "type": "string" }, { - "description": "the ipsec preshared key", - "name": "presharedkey", - "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", + "description": "the range of ips to allocate to the clients", + "name": "iprange", "type": "string" }, {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the account of the remote access vpn", + "name": "account", "type": "string" }, { - "description": "the account of the remote access vpn", - "name": "account", + "description": "the project id of the vpn", + "name": "projectid", "type": "string" }, - {} + { + "description": "the public ip address of the vpn server", + "name": "publicip", + "type": "string" + } ] }, { @@ -14337,64 +14841,43 @@ "related": "destroyRouter,listRouters,rebootRouter,changeServiceForRouter,stopInternalLoadBalancerVM,startInternalLoadBalancerVM,listInternalLoadBalancerVMs,stopNetScalerVpx", "response": [ { - "description": "the network domain for the router", - "name": "networkdomain", - "type": "string" - }, - { - "description": "the Zone name for the router", - "name": "zonename", + "description": "the public MAC address for the router", + "name": "publicmacaddress", "type": "string" }, { - "description": "the link local IP address for the router", - "name": "linklocalip", - "type": "string" + "description": "the date and time the router was created", + "name": "created", + "type": "date" }, { - "description": "the host ID for the router", - "name": "hostid", + "description": "the gateway for the router", + "name": "gateway", "type": "string" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "the 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 project id of the ipaddress", - "name": "projectid", - "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 ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "the account associated with the router", + "name": "account", "type": "string" }, { - "description": "the public MAC address for the router", - "name": "publicmacaddress", + "description": "the project id of the ipaddress", + "name": "projectid", "type": "string" }, { - "description": "the state of redundant virtual router", - "name": "redundantstate", + "description": "the Pod name for the router", + "name": "podname", "type": "string" }, { @@ -14403,39 +14886,9 @@ "type": "string" }, { - "description": "the Zone ID for the router", - "name": "zoneid", - "type": "string" - }, - { - "description": "the name of the router", - "name": "name", - "type": "string" - }, - { - "description": "the second IPv6 DNS for the router", - "name": "ip6dns2", - "type": "string" - }, - { - "description": "the domain associated with the router", - "name": "domain", - "type": "string" - }, - { - "description": "role of the domain router", - "name": "role", - "type": "string" - }, - { - "description": "the first DNS for the router", - "name": "dns1", - "type": "string" - }, - { - "description": "the ID of the corresponding guest network", - "name": "guestnetworkid", - "type": "string" + "description": "if this router is an redundant virtual router", + "name": "isredundantrouter", + "type": "boolean" }, { "description": "the guest IP address for the router", @@ -14443,43 +14896,33 @@ "type": "string" }, { - "description": "the Pod ID for the router", - "name": "podid", - "type": "string" - }, - { - "description": "the public netmask for the router", - "name": "publicnetmask", + "description": "the link local MAC address for the router", + "name": "linklocalmacaddress", "type": "string" }, { - "description": "true if any health checks had failed", - "name": "healthchecksfailed", - "type": "boolean" - }, - { - "description": "the hostname for the router", - "name": "hostname", + "description": "the domain associated with the router", + "name": "domain", "type": "string" }, { - "description": "the gateway for the router", - "name": "gateway", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, { - "description": "the project name of the address", - "name": "project", + "description": "the network domain for the router", + "name": "networkdomain", "type": "string" }, { - "description": "the state of the router", - "name": "state", - "type": "state" + "description": "the hostname for the router", + "name": "hostname", + "type": "string" }, { - "description": "the name of VPC the router belongs to", - "name": "vpcname", + "description": "the version of scripts", + "name": "scriptsversion", "type": "string" }, { @@ -14488,38 +14931,39 @@ "type": "boolean" }, { - "description": "the domain ID associated with the router", - "name": "domainid", + "description": "the guest netmask for the router", + "name": "guestnetmask", "type": "string" }, { - "description": "the ID of the corresponding public network", - "name": "publicnetworkid", + "description": "role of the domain router", + "name": "role", "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 guest MAC address for the router", - "name": "guestmacaddress", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the account associated with the router", - "name": "account", + "description": "VPC the router belongs to", + "name": "vpcid", "type": "string" }, { - "description": "the version of scripts", - "name": "scriptsversion", + "description": "the template ID for the router", + "name": "templateid", "type": "string" }, { - "description": "the template name for the router", - "name": "templatename", + "description": "the Pod ID for the router", + "name": "podid", "type": "string" }, { @@ -14528,23 +14972,28 @@ "type": "string" }, { - "description": "the date and time the router was created", - "name": "created", - "type": "date" + "description": "the first DNS for the router", + "name": "dns1", + "type": "string" }, { - "description": "the name of the corresponding guest network", - "name": "guestnetworkname", + "description": "the guest MAC address for the router", + "name": "guestmacaddress", "type": "string" }, { - "description": "the first IPv6 DNS for the router", - "name": "ip6dns1", + "description": "the state of the router", + "name": "state", + "type": "state" + }, + { + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the Pod name for the router", - "name": "podname", + "description": "the Zone name for the router", + "name": "zonename", "type": "string" }, { @@ -14553,29 +15002,43 @@ "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the name of VPC the router belongs to", + "name": "vpcname", + "type": "string" }, - {}, { - "description": "the id of the router", - "name": "id", + "description": "the domain ID associated with the router", + "name": "domainid", "type": "string" }, { - "description": "the second DNS for the router", - "name": "dns2", + "description": "the project name of the address", + "name": "project", "type": "string" }, { - "description": "the link local MAC address for the router", - "name": "linklocalmacaddress", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the template ID for the router", - "name": "templateid", + "description": "the template name for the router", + "name": "templatename", + "type": "string" + }, + { + "description": "the ID of the corresponding public network", + "name": "publicnetworkid", + "type": "string" + }, + { + "description": "the name of the corresponding guest network", + "name": "guestnetworkname", + "type": "string" + }, + { + "description": "the version of the code / software in the router", + "name": "softwareversion", "type": "string" }, { @@ -14583,56 +15046,96 @@ "name": "healthcheckresults", "response": [ { - "description": "the type of the health check - basic or advanced", - "name": "checktype", + "description": "detailed response generated on running health check", + "name": "details", "type": "string" }, + { + "description": "the date this VPC was created", + "name": "lastupdated", + "type": "date" + }, { "description": "result of the health check", "name": "success", "type": "boolean" }, { - "description": "the name of the health check on the router", - "name": "checkname", + "description": "the type of the health check - basic or advanced", + "name": "checktype", "type": "string" }, { - "description": "the date this VPC was created", - "name": "lastupdated", - "type": "date" - }, - { - "description": "detailed response generated on running health check", - "name": "details", + "description": "the name of the health check on the router", + "name": "checkname", "type": "string" } ], "type": "list" }, { - "description": "the guest netmask for the router", - "name": "guestnetmask", + "description": "the Zone ID for the router", + "name": "zoneid", + "type": "string" + }, + { + "description": "the public netmask for the router", + "name": "publicnetmask", + "type": "string" + }, + { + "description": "the id of the router", + "name": "id", + "type": "string" + }, + { + "description": "the state of redundant virtual router", + "name": "redundantstate", + "type": "string" + }, + { + "description": "the first IPv6 DNS for the router", + "name": "ip6dns1", + "type": "string" + }, + { + "description": "the second DNS for the router", + "name": "dns2", + "type": "string" + }, + { + "description": "the host ID for the router", + "name": "hostid", + "type": "string" + }, + { + "description": "the ID of the corresponding guest network", + "name": "guestnetworkid", "type": "string" }, + { + "description": "true if any health checks had failed", + "name": "healthchecksfailed", + "type": "boolean" + }, { "description": "the list of nics associated with the router", "name": "nic", "response": [ { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "type": "string" }, { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", "type": "string" }, { - "description": "Type of adapter if available", - "name": "adaptertype", - "type": "string" + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" }, { "description": "the ip address of the nic", @@ -14640,33 +15143,33 @@ "type": "string" }, { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" }, { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" + "description": "the gateway of the nic", + "name": "gateway", + "type": "string" }, { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "the type of the nic", + "name": "type", "type": "string" }, { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "description": "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 name of the corresponding network", + "name": "networkname", "type": "string" }, { @@ -14675,8 +15178,13 @@ "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { @@ -14685,23 +15193,18 @@ "type": "boolean" }, { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - }, - { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", + "type": "string" }, { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", "type": "string" }, { - "description": "the type of the nic", - "name": "type", + "description": "the traffic type of the nic", + "name": "traffictype", "type": "string" }, { @@ -14710,39 +15213,49 @@ "type": "string" }, { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", "type": "string" }, { - "description": "the IPv6 address of network", - "name": "ip6address", + "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 ID of the nic", "name": "id", "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 broadcast uri of the nic", - "name": "broadcasturi", + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", "type": "string" }, { - "description": "the gateway of the nic", - "name": "gateway", + "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": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" }, { "description": "the netmask of the nic", @@ -14753,13 +15266,19 @@ "type": "set" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the second IPv6 DNS for the router", + "name": "ip6dns2", + "type": "string" + }, + {}, + { + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", + "type": "string" }, { - "description": "VPC the router belongs to", - "name": "vpcid", + "description": "the name of the router", + "name": "name", "type": "string" } ] @@ -14769,6 +15288,22 @@ "isasync": false, "name": "changeServiceForVirtualMachine", "params": [ + { + "description": "New maximum number of IOPS for the custom disk offering", + "length": 255, + "name": "maxiops", + "required": false, + "since": "4.17", + "type": "long" + }, + { + "description": "Flag for automatic migration of the root volume with new compute offering whenever migration is required to apply the offering", + "length": 255, + "name": "automigrate", + "required": false, + "since": "4.17", + "type": "boolean" + }, { "description": "The ID of the virtual machine", "length": 255, @@ -14778,46 +15313,265 @@ "type": "uuid" }, { - "description": "name value pairs of custom parameters for cpu, memory and cpunumber. example details[i].name=value", - "length": 255, + "description": "New minimum number of IOPS for the custom disk offering", + "length": 255, + "name": "miniops", + "required": false, + "since": "4.17", + "type": "long" + }, + { + "description": "the service offering ID to apply to the virtual machine", + "length": 255, + "name": "serviceofferingid", + "related": "createServiceOffering,updateServiceOffering,listServiceOfferings", + "required": true, + "type": "uuid" + }, + { + "description": "name value pairs of custom parameters for cpu, memory and cpunumber. example details[i].name=value", + "length": 255, + "name": "details", + "required": false, + "type": "map" + }, + { + "description": "Verify OK to Shrink", + "length": 255, + "name": "shrinkok", + "required": false, + "since": "4.17", + "type": "boolean" + } + ], + "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,revertToVMSnapshot,updateVmNicIp,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance", + "response": [ + { + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", + "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": "publicip", + "type": "string" + }, + { + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" + }, + { + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", + "type": "string" + }, + { + "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 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 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 ID of the disk offering of the virtual machine", + "name": "diskofferingid", + "type": "string" + }, + { + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" + }, + { + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", + "type": "string" + }, + { + "description": "the ID of the virtual machine", + "name": "id", + "type": "string" + }, + { + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", + "type": "string" + }, + { + "description": "OS name of the vm", + "name": "osdisplayname", + "type": "string" + }, + { + "description": "the memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" + }, + { + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" + }, + { + "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 account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" + }, + { + "description": "the project name of the vm", + "name": "project", + "type": "string" + }, + { + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", + "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", - "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" - } - ], - "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,revertToVMSnapshot,updateVmNicIp,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance", - "response": [ + "description": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" + }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "ssh key-pairs", + "name": "keypairs", "type": "string" }, { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", - "type": "string" + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" }, { - "description": "the read (bytes) of disk on the vm", + "description": "the VM's disk read in KiB", "name": "diskkbsread", "type": "long" }, { - "description": "OS name of the vm", - "name": "osdisplayname", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", + "type": "string" + }, + { + "description": "the group name of the virtual machine", + "name": "group", + "type": "string" + }, + { + "description": "the user's name who deployed the virtual machine", + "name": "username", "type": "string" }, { @@ -14826,494 +15580,402 @@ "type": "boolean" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "the pool type of the virtual machine", + "name": "pooltype", "type": "string" }, { - "description": "the password (if exists) of the virtual machine", - "name": "password", + "description": "the ID of the availablility zone for the virtual machine", + "name": "zoneid", "type": "string" }, { - "description": "the memory used by the vm", - "name": "memorykbs", - "type": "long" + "description": "State of the Service from LB rule", + "name": "servicestate", + "type": "string" }, { - "description": "the outgoing network traffic on the host", - "name": "networkkbswrite", - "type": "long" + "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": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", "type": "string" }, { - "description": "the read (io) of disk on the vm", - "name": "diskioread", + "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 ID of the domain in which the virtual machine exists", + "name": "domainid", + "type": "string" + }, + { + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", "type": "long" }, { - "description": "true if 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": "public IP address id associated with vm via Static nat rule", - "name": "publicip", + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" + }, + { + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", "type": "string" }, { - "description": "the incoming network traffic on the vm", - "name": "networkkbsread", + "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", "type": "long" }, { - "description": "device type of the root volume", - "name": "rootdevicetype", + "description": "OS type id of the vm", + "name": "ostypeid", "type": "string" }, + {}, { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", + "description": "Guest vm Boot Type", + "name": "boottype", "type": "string" }, { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, { - "description": "the name of the 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 project name of the vm", - "name": "project", + "description": "the password (if exists) of the virtual machine", + "name": "password", "type": "string" }, { - "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 total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" + "description": "Os type ID of the virtual machine", + "name": "guestosid", + "type": "string" }, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", "type": "string" }, { - "description": "the ID of the availablility zone for the virtual machine", - "name": "zoneid", + "description": "the project id of the vm", + "name": "projectid", "type": "string" }, { - "description": "ssh key-pair", - "name": "keypair", + "description": "the state of the virtual machine", + "name": "state", "type": "string" }, { - "description": "the target memory in vm", + "description": "the target memory in VM (KiB)", "name": "memorytargetkbs", "type": "long" }, { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", - "type": "string" - }, - { - "description": "the 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 ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", + "description": "the name of the virtual machine", + "name": "name", "type": "string" }, { - "description": "the state of the virtual machine", - "name": "state", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { - "description": "the list of nics associated with vm", - "name": "nic", + "description": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", "response": [ { - "description": "the traffic type of the nic", - "name": "traffictype", - "type": "string" - }, - { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", - "type": "string" - }, - { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "description": "the name of the corresponding network", - "name": "networkname", - "type": "string" - }, - { - "description": "the gateway of the nic", - "name": "gateway", - "type": "string" - }, - { - "description": "the IPv6 address of network", - "name": "ip6address", - "type": "string" - }, - { - "description": "the type of the nic", - "name": "type", - "type": "string" - }, - { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "the description of the affinity group", + "name": "description", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "the domain name of the affinity group", + "name": "domain", "type": "string" }, { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" - }, - { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", "type": "list" }, { - "description": "the ID of the nic", - "name": "id", - "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 netmask of the nic", - "name": "netmask", - "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": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "the name of the affinity group", + "name": "name", "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 affinity group", + "name": "id", "type": "string" }, { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", + "description": "the account owning the affinity group", + "name": "account", "type": "string" }, { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "the project name of the affinity group", + "name": "project", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "the project ID of the affinity group", + "name": "projectid", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the domain ID of the affinity group", + "name": "domainid", "type": "string" }, { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "description": "the type of the affinity group", + "name": "type", "type": "string" } ], "type": "set" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "Guest vm Boot Mode", + "name": "bootmode", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the group ID of the virtual machine", + "name": "groupid", + "type": "string" }, { - "description": "the speed of each cpu", - "name": "cpuspeed", - "type": "integer" + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", + "type": "string" }, { - "description": "the name of the disk offering of the virtual machine", - "name": "diskofferingname", + "description": "the read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" + }, + { + "description": "the name of the host for the virtual machine", + "name": "hostname", "type": "string" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", "type": "string" }, { - "description": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the user's ID who deployed the virtual machine", + "name": "userid", + "type": "string" + }, + { + "description": "device type of the root volume", + "name": "rootdevicetype", + "type": "string" + }, + { + "description": "the list of nics associated with vm", + "name": "nic", "response": [ { - "description": "the type of the affinity group", - "name": "type", + "description": "the netmask of the nic", + "name": "netmask", "type": "string" }, { - "description": "the project ID of the affinity group", - "name": "projectid", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "the account owning the affinity group", - "name": "account", + "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 ip address of the nic", + "name": "ipaddress", "type": "string" }, { - "description": "the ID of the affinity group", - "name": "id", + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", "type": "string" }, { - "description": "the description of the affinity group", - "name": "description", - "type": "string" + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" }, { - "description": "the domain name of the affinity group", - "name": "domain", + "description": "the type of the nic", + "name": "type", "type": "string" }, { - "description": "the name of the affinity group", - "name": "name", - "type": "string" + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" }, { - "description": "the domain ID of the affinity group", - "name": "domainid", + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", "type": "string" }, { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" - } - ], - "type": "set" - }, - { - "description": "list of security groups associated with the virtual machine", - "name": "securitygroup", - "response": [ - { - "description": "the ID of the security group", - "name": "id", + "description": "the traffic type of the nic", + "name": "traffictype", "type": "string" }, { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" - }, - { - "description": "the name of the security group", - "name": "name", + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", "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 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": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the 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 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": "security group name", - "name": "securitygroupname", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the account owning the security group", - "name": "account", + "description": "the ID of the nic", + "name": "id", "type": "string" }, { - "description": "the domain ID of the security group", - "name": "domainid", + "description": "the ID of the corresponding network", + "name": "networkid", "type": "string" }, { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", + "description": "true if nic is default, false otherwise", + "name": "macaddress", + "type": "string" + }, + { + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", + "type": "string" + }, + { + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "the gateway of the nic", + "name": "gateway", + "type": "string" + }, + { + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", + "type": "string" + }, + { + "description": "the name of the corresponding network", + "name": "networkname", + "type": "string" + }, + { + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", "type": "integer" }, + { + "description": "the isolation uri of the nic", + "name": "isolationuri", + "type": "string" + }, + { + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", + "type": "string" + }, + { + "description": "the broadcast uri of the nic", + "name": "broadcasturi", + "type": "string" + }, + { + "description": "the IPv6 address of network", + "name": "ip6address", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "list of security groups associated with the virtual machine", + "name": "securitygroup", + "response": [ { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "tag key name", - "name": "key", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { @@ -15322,28 +15984,28 @@ "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 id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { @@ -15352,89 +16014,89 @@ "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 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 project id of the group", "name": "projectid", "type": "string" }, + { + "description": "the ID of the security group", + "name": "id", + "type": "string" + }, { "description": "the domain name of the security group", "name": "domain", "type": "string" }, + { + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" + }, + { + "description": "the project name of the group", + "name": "project", + "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", + "description": "the domain ID of the security group", + "name": "domainid", + "type": "string" + }, + { + "description": "the list of ingress rules associated with the security group", + "name": "ingressrule", "response": [ { "description": "the id of the security group rule", "name": "ruleid", "type": "string" }, - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "account owning the security group rule", - "name": "account", - "type": "string" - }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "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": "id of the resource", - "name": "resourceid", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { @@ -15443,18 +16105,18 @@ "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { @@ -15471,20 +16133,40 @@ "type": "set" }, { - "description": "the code for the ICMP message response", - "name": "icmpcode", + "description": "the ending IP of the security group rule ", + "name": "endport", "type": "integer" }, { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" }, { "description": "security group name", "name": "securitygroupname", "type": "string" }, + { + "description": "account owning the security group rule", + "name": "account", + "type": "string" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, { "description": "the type of the ICMP message response", "name": "icmptype", @@ -15492,259 +16174,138 @@ } ], "type": "set" - } - ], - "type": "set" - }, - {}, - { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", - "type": "string" - }, - { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" - }, - { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", - "type": "string" - }, - { - "description": "the write (io) of disk on the vm", - "name": "diskiowrite", - "type": "long" - }, - { - "description": "the ID of the disk offering of the virtual machine", - "name": "diskofferingid", - "type": "string" - }, - { - "description": "Guest vm Boot Type", - "name": "boottype", - "type": "string" - }, - { - "description": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" - }, - { - "description": "the group name of the virtual machine", - "name": "group", - "type": "string" - }, - { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "the write (bytes) of disk on the vm", - "name": "diskkbswrite", - "type": "long" - }, - { - "description": "the name of the virtual machine", - "name": "name", - "type": "string" - }, - { - "description": "OS type id of the vm", - "name": "ostypeid", - "type": "string" - }, - { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", - "type": "boolean" - }, - { - "description": "Os type ID of the virtual machine", - "name": "guestosid", - "type": "string" - }, - {}, - { - "description": "the internal memory that's free in vm or zero if it can not be calculated", - "name": "memoryintfreekbs", - "type": "long" - }, - { - "description": "the number of cpu this virtual machine is running with", - "name": "cpunumber", - "type": "integer" - }, - { - "description": "the user's name who deployed the virtual machine", - "name": "username", - "type": "string" - }, - { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", - "type": "boolean" - }, - { - "description": "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" - }, - { - "description": "the name of the host for the virtual machine", - "name": "hostname", - "type": "string" - }, - { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" - }, - { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", - "type": "string" - }, - { - "description": "the list of resource tags associated", - "name": "tags", - "response": [ - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the 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", + "description": "the account owning the security group", "name": "account", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", + "description": "the name of the security group", + "name": "name", "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 account associated with the virtual machine", - "name": "account", - "type": "string" - }, - { - "description": "the project id of the vm", - "name": "projectid", - "type": "string" - }, - { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" - }, - { - "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": "State of the Service from LB rule", - "name": "servicestate", - "type": "string" - }, - { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" - }, - {}, - { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", - "type": "string" - }, - { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the vgpu type used by the virtual machine", - "name": "vgpu", - "type": "string" + "description": "the list of egress rules associated with the security group", + "name": "egressrule", + "response": [ + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "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" + }, + { + "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": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + } + ], + "type": "set" + } + ], + "type": "set" }, { - "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 ID of the virtual machine", - "name": "id", + "description": "the ID of the host for the virtual machine", + "name": "hostid", "type": "string" - }, - { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" } ] }, @@ -15754,34 +16315,26 @@ "name": "resetConfiguration", "params": [ { - "description": "the ID of the Image Store to reset the parameter value for corresponding image store", - "length": 255, - "name": "imagestoreid", - "related": "addSecondaryStorage,listSwifts,updateImageStore,addImageStore,addImageStoreS3,listImageStores,createSecondaryStagingStore,updateCloudToUseObjectStore", - "required": false, - "type": "uuid" - }, - { - "description": "the ID of the Storage pool to reset the parameter value for corresponding storage pool", + "description": "the ID of the Zone to reset the parameter value for corresponding zone", "length": 255, - "name": "storageid", - "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, "type": "uuid" }, { - "description": "the ID of the Cluster to reset the parameter value for corresponding cluster", + "description": "the ID of the Image Store to reset the parameter value for corresponding image store", "length": 255, - "name": "clusterid", - "related": "addCluster,updateCluster", + "name": "imagestoreid", + "related": "addSecondaryStorage,listSwifts,updateImageStore,addImageStore,addImageStoreS3,listImageStores,createSecondaryStagingStore,updateCloudToUseObjectStore", "required": false, "type": "uuid" }, { - "description": "the ID of the Zone to reset the parameter value for corresponding zone", + "description": "the ID of the Account to reset the parameter value for corresponding account", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "accountid", + "related": "createAccount,disableAccount,enableAccount,updateAccount,markDefaultZoneForAccount,listAccounts,listAccounts", "required": false, "type": "uuid" }, @@ -15793,10 +16346,18 @@ "type": "string" }, { - "description": "the ID of the Account to reset the parameter value for corresponding account", + "description": "the ID of the Cluster to reset the parameter value for corresponding cluster", "length": 255, - "name": "accountid", - "related": "createAccount,disableAccount,enableAccount,updateAccount,markDefaultZoneForAccount,listAccounts,listAccounts", + "name": "clusterid", + "related": "addCluster,updateCluster", + "required": false, + "type": "uuid" + }, + { + "description": "the ID of the Storage pool to reset the parameter value for corresponding storage pool", + "length": 255, + "name": "storageid", + "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities", "required": false, "type": "uuid" }, @@ -15812,50 +16373,50 @@ "related": "listConfigurations,updateConfiguration", "response": [ { - "description": "scope(zone/cluster/pool/account) of the parameter that needs to be updated", - "name": "scope", + "description": "the name of the configuration", + "name": "name", "type": "string" }, { - "description": "the description of the configuration", - "name": "description", + "description": "scope(zone/cluster/pool/account) of the parameter that needs to be updated", + "name": "scope", "type": "string" }, + {}, { "description": "the value of the configuration", "name": "id", "type": "long" }, + {}, + { + "description": "the description of the configuration", + "name": "description", + "type": "string" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - {}, - {}, { - "description": "the name of the configuration", - "name": "name", + "description": "the value of the configuration", + "name": "value", "type": "string" }, - { - "description": "true if the configuration is dynamic", - "name": "isdynamic", - "type": "boolean" - }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "the category of the configuration", - "name": "category", - "type": "string" + "description": "true if the configuration is dynamic", + "name": "isdynamic", + "type": "boolean" }, { - "description": "the value of the configuration", - "name": "value", + "description": "the category of the configuration", + "name": "category", "type": "string" } ], @@ -15866,13 +16427,6 @@ "isasync": false, "name": "listGuestOsMapping", "params": [ - { - "description": "list Guest OS mapping by hypervisor version. Must be used with hypervisor parameter", - "length": 255, - "name": "hypervisorversion", - "required": false, - "type": "string" - }, { "description": "list mapping by its UUID", "length": 255, @@ -15882,19 +16436,19 @@ "type": "uuid" }, { - "description": "list mapping by Guest OS Type UUID", + "description": "list Guest OS mapping by hypervisor version. Must be used with hypervisor parameter", "length": 255, - "name": "ostypeid", - "related": "listOsTypes,addGuestOs", + "name": "hypervisorversion", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "List by keyword", + "description": "list mapping by Guest OS Type UUID", "length": 255, - "name": "keyword", + "name": "ostypeid", + "related": "listOsTypes,addGuestOs", "required": false, - "type": "string" + "type": "uuid" }, { "description": "list Guest OS mapping by hypervisor", @@ -15910,6 +16464,13 @@ "required": false, "type": "integer" }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + }, { "description": "", "length": 255, @@ -15920,30 +16481,24 @@ ], "related": "addGuestOsMapping,updateGuestOsMapping", "response": [ - { - "description": "the hypervisor", - "name": "hypervisor", - "type": "string" - }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - {}, { - "description": "the ID of the Guest OS type", - "name": "ostypeid", + "description": "is the mapping user defined", + "name": "isuserdefined", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the ID of the Guest OS mapping", + "name": "id", "type": "string" }, { - "description": "hypervisor specific name for the Guest OS", - "name": "osnameforhypervisor", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -15952,10 +16507,11 @@ "type": "string" }, { - "description": "is the mapping user defined", - "name": "isuserdefined", + "description": "hypervisor specific name for the Guest OS", + "name": "osnameforhypervisor", "type": "string" }, + {}, { "description": "standard display name for the Guest OS", "name": "osdisplayname", @@ -15963,8 +16519,13 @@ }, {}, { - "description": "the ID of the Guest OS mapping", - "name": "id", + "description": "the hypervisor", + "name": "hypervisor", + "type": "string" + }, + { + "description": "the ID of the Guest OS type", + "name": "ostypeid", "type": "string" } ], @@ -15976,92 +16537,99 @@ "name": "listTemplates", "params": [ { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "list templates by zoneId", "length": 255, - "name": "account", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "flag to display the resource image for the templates", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "showicon", + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "required": false, + "type": "uuid" + }, + { + "description": "If set to true, list only unique templates across zones", + "length": 255, + "name": "showunique", "required": false, + "since": "4.13.2", "type": "boolean" }, { - "description": "List by keyword", + "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": "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": "show removed templates as well", "length": 255, - "name": "templatefilter", - "required": true, - "type": "string" + "name": "showremoved", + "required": false, + "type": "boolean" }, { - "description": "list only resources belonging to the domain specified", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", + "name": "listall", "required": false, - "type": "uuid" + "type": "boolean" }, { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, { - "description": "the template ID", + "description": "flag to display the resource image for the templates", "length": 255, - "name": "id", - "related": "prepareTemplate,listIsos,registerIso,updateIso,copyTemplate,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", + "name": "showicon", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "list objects by project", + "description": "the template ID", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "name": "id", + "related": "prepareTemplate,listIsos,registerIso,updateIso,copyTemplate,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", "required": false, "type": "uuid" }, { - "description": "the template name", + "description": "List resources by tags (key/value pairs)", "length": 255, - "name": "name", + "name": "tags", "required": false, - "type": "string" + "type": "map" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "", "length": 255, - "name": "isrecursive", + "name": "pagesize", "required": false, - "type": "boolean" + "type": "integer" }, { - "description": "comma separated list of template details requested, value can be a list of [ all, min]", + "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": "details", - "required": false, - "since": "4.15", - "type": "list" + "name": "templatefilter", + "required": true, + "type": "string" }, { - "description": "show removed templates as well", + "description": "the template name", "length": 255, - "name": "showremoved", + "name": "name", "required": false, - "type": "boolean" + "type": "string" }, { "description": "the IDs of the templates, mutually exclusive with id", @@ -16073,20 +16641,11 @@ "type": "list" }, { - "description": "list templates by zoneId", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": false, - "type": "uuid" - }, - { - "description": "If set to true, list only unique templates across zones", + "description": "List by keyword", "length": 255, - "name": "showunique", + "name": "keyword", "required": false, - "since": "4.13.2", - "type": "boolean" + "type": "string" }, { "description": "list datadisk templates by parent template id", @@ -16098,65 +16657,57 @@ "type": "uuid" }, { - "description": "List resources by tags (key/value pairs)", + "description": "the hypervisor for which to restrict the search", "length": 255, - "name": "tags", + "name": "hypervisor", "required": false, - "type": "map" + "type": "string" }, { - "description": "the hypervisor for which to restrict the search", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "hypervisor", + "name": "account", "required": false, "type": "string" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "listall", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "", + "description": "comma separated list of template details requested, value can be a list of [ all, min]", "length": 255, - "name": "page", + "name": "details", "required": false, - "type": "integer" + "since": "4.15", + "type": "list" } ], "related": "prepareTemplate,listIsos,registerIso,updateIso,copyTemplate,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", "response": [ + { + "description": "the template display text", + "name": "displaytext", + "type": "string" + }, { "description": "true if the template is ready to be deployed from, false otherwise.", "name": "isready", "type": "boolean" }, { - "description": "the name of the OS type for this template.", - "name": "ostypename", + "description": "the template name", + "name": "name", "type": "string" }, { - "description": "the size of the template", - "name": "size", - "type": "long" - }, - { - "description": "if root disk template, then ids of the datas disk templates this template owns", - "name": "childtemplates", - "type": "set" - }, - { - "description": "the format of the template.", - "name": "format", - "type": "imageformat" - }, - { - "description": "true if the ISO is bootable, false otherwise", - "name": "bootable", - "type": "boolean" + "description": "the name of the zone for this template", + "name": "zonename", + "type": "string" }, { "description": "VMware only: true if template is deployed without orchestrating disks and networks but \"as-is\" defined in the template.", @@ -16164,13 +16715,18 @@ "type": "boolean" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the name of the domain to which the template belongs", + "name": "domain", "type": "string" }, { - "description": "the ID of the secondary storage host for the template", - "name": "hostid", + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the status of the template", + "name": "status", "type": "string" }, { @@ -16178,15 +16734,9 @@ "name": "account", "type": "string" }, - {}, - { - "description": "VMware only: additional key/value details tied with deploy-as-is template", - "name": "deployasisdetails", - "type": "map" - }, { - "description": "checksum of the template", - "name": "checksum", + "description": "if Datadisk template, then id of the root disk template this template belongs to", + "name": "parenttemplateid", "type": "string" }, { @@ -16194,14 +16744,34 @@ "name": "crossZones", "type": "boolean" }, + { + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" + }, + { + "description": "the size of the template", + "name": "size", + "type": "long" + }, + { + "description": "the template ID of the parent template if present", + "name": "sourcetemplateid", + "type": "string" + }, + { + "description": "the project id of the template", + "name": "projectid", + "type": "string" + }, { "description": "the name of the secondary storage host for the template", "name": "hostname", "type": "string" }, { - "description": "true if template requires HVM enabled, false otherwise", - "name": "requireshvm", + "description": "true if the ISO is bootable, false otherwise", + "name": "bootable", "type": "boolean" }, { @@ -16210,23 +16780,23 @@ "type": "string" }, { - "description": "true if this template is a featured template, false otherwise", - "name": "isfeatured", - "type": "boolean" + "description": "the tag of this template", + "name": "templatetag", + "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "additional key/value details tied with template", + "name": "details", + "type": "map" }, { - "description": "the ID of the zone for this template", - "name": "zoneid", - "type": "string" + "description": "true if template requires HVM enabled, false otherwise", + "name": "requireshvm", + "type": "boolean" }, { - "description": "true if template is sshkey enabled, false otherwise", - "name": "sshkeyenabled", + "description": "true if the template is extractable, false otherwise", + "name": "isextractable", "type": "boolean" }, { @@ -16235,69 +16805,69 @@ "type": "int" }, { - "description": "the template ID", - "name": "id", - "type": "string" + "description": "Lists the download progress of a template across all secondary storages", + "name": "downloaddetails", + "type": "list" }, { - "description": "the status of the template", - "name": "status", + "description": "the URL which the template/iso is registered from", + "name": "url", "type": "string" }, + {}, { - "description": "true if the reset password feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" + "description": "VMware only: additional key/value details tied with deploy-as-is template", + "name": "deployasisdetails", + "type": "map" }, { - "description": "the physical size of the template", - "name": "physicalsize", - "type": "long" + "description": "if root disk template, then ids of the datas disk templates this template owns", + "name": "childtemplates", + "type": "set" }, - {}, { - "description": "the ID of the domain to which the template belongs", - "name": "domainid", + "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": "the format of the template.", + "name": "format", + "type": "imageformat" }, { - "description": "true if the template is extractable, false otherwise", - "name": "isextractable", + "description": "true if the reset password feature is enabled, false otherwise", + "name": "passwordenabled", "type": "boolean" }, { - "description": "the URL which the template/iso is registered from", - "name": "url", + "description": "the ID of the domain to which the template belongs", + "name": "domainid", "type": "string" }, { - "description": "Lists the download progress of a template across all secondary storages", - "name": "downloaddetails", - "type": "list" + "description": "the project name of the template", + "name": "project", + "type": "string" }, { - "description": "the template name", - "name": "name", - "type": "string" + "description": "true if this template is a public template, false otherwise", + "name": "ispublic", + "type": "boolean" }, { - "description": "the ID of the OS type for this template.", - "name": "ostypeid", - "type": "string" + "description": "true if this template is a featured template, false otherwise", + "name": "isfeatured", + "type": "boolean" }, { - "description": "the name of the domain to which the template belongs", - "name": "domain", + "description": "the ID of the zone for this template", + "name": "zoneid", "type": "string" }, { - "description": "if Datadisk template, then id of the root disk template this template belongs to", - "name": "parenttemplateid", + "description": "checksum of the template", + "name": "checksum", "type": "string" }, { @@ -16305,28 +16875,33 @@ "name": "tags", "response": [ { - "description": "resource type", - "name": "resourcetype", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { @@ -16335,18 +16910,13 @@ "type": "string" }, { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { @@ -16358,9 +16928,9 @@ "type": "set" }, { - "description": "the tag of this template", - "name": "templatetag", - "type": "string" + "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", + "name": "directdownload", + "type": "boolean" }, { "description": "the date this template was created", @@ -16368,33 +16938,28 @@ "type": "date" }, { - "description": "the project id of the template", - "name": "projectid", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "true if template is sshkey enabled, false otherwise", + "name": "sshkeyenabled", + "type": "boolean" }, { - "description": "the template ID of the parent template if present", - "name": "sourcetemplateid", + "description": "the ID of the secondary storage host for the template", + "name": "hostid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "true if 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": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the template display text", - "name": "displaytext", + "description": "the template ID", + "name": "id", "type": "string" }, { @@ -16403,34 +16968,30 @@ "type": "date" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the name of the OS type for this template.", + "name": "ostypename", + "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": "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 account id to which the template belongs", - "name": "accountid", - "type": "string" + "description": "the physical size of the template", + "name": "physicalsize", + "type": "long" }, { - "description": "the name of the zone for this template", - "name": "zonename", + "description": "the ID of the OS type for this template.", + "name": "ostypeid", "type": "string" - }, - { - "description": "additional key/value details tied with template", - "name": "details", - "type": "map" } ] }, @@ -16439,13 +17000,6 @@ "isasync": true, "name": "createAutoScalePolicy", "params": [ - { - "description": "the cool down period for which the policy should not be evaluated after the action has been taken", - "length": 255, - "name": "quiettime", - "required": false, - "type": "integer" - }, { "description": "the action to be executed if all the conditions evaluate to true for the specified duration.", "length": 255, @@ -16453,6 +17007,13 @@ "required": true, "type": "string" }, + { + "description": "the cool down period for which the policy should not be evaluated after the action has been taken", + "length": 255, + "name": "quiettime", + "required": false, + "type": "integer" + }, { "description": "the list of IDs of the conditions that are being evaluated on every interval", "length": 255, @@ -16471,46 +17032,35 @@ ], "related": "listAutoScalePolicies,updateAutoScalePolicy", "response": [ + {}, { - "description": "the cool down period for which the policy should not be evaluated after the action has been taken", - "name": "quiettime", - "type": "integer" - }, - { - "description": "the project name of the autoscale policy", - "name": "project", + "description": "the action to be executed if all the conditions evaluate to true for the specified duration.", + "name": "action", "type": "string" }, { - "description": "the autoscale policy ID", - "name": "id", + "description": "the domain ID of the autoscale policy", + "name": "domainid", "type": "string" }, - {}, { "description": "the project id autoscale policy", "name": "projectid", "type": "string" }, - {}, - { - "description": "the domain ID of the autoscale policy", - "name": "domainid", - "type": "string" - }, { "description": "the domain name of the autoscale policy", "name": "domain", "type": "string" }, { - "description": "the duration for which the conditions have to be true before action is taken", - "name": "duration", - "type": "integer" + "description": "the list of IDs of the conditions that are being evaluated on every interval", + "name": "conditions", + "type": "list" }, { - "description": "the account owning the autoscale policy", - "name": "account", + "description": "the autoscale policy ID", + "name": "id", "type": "string" }, { @@ -16519,9 +17069,19 @@ "type": "string" }, { - "description": "the list of IDs of the conditions that are being evaluated on every interval", - "name": "conditions", - "type": "list" + "description": "the account owning the autoscale policy", + "name": "account", + "type": "string" + }, + { + "description": "the cool down period for which the policy should not be evaluated after the action has been taken", + "name": "quiettime", + "type": "integer" + }, + { + "description": "the duration for which the conditions have to be true before action is taken", + "name": "duration", + "type": "integer" }, { "description": "the current status of the latest async job acting on this object", @@ -16529,10 +17089,11 @@ "type": "integer" }, { - "description": "the action to be executed if all the conditions evaluate to true for the specified duration.", - "name": "action", + "description": "the project name of the autoscale policy", + "name": "project", "type": "string" - } + }, + {} ] }, { @@ -16544,35 +17105,82 @@ "description": "the host ID of ssp server", "length": 255, "name": "hostid", - "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost,addBaremetalHost,listExternalLoadBalancers", + "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost", "required": true, "type": "uuid" } ], "response": [ + {}, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + } + ] + }, + { + "description": "Lists Usage Server metrics", + "isasync": false, + "name": "listUsageServerMetrics", + "params": [], + "related": "", + "response": [ {}, + { + "description": "the last time a usage job successfully completed", + "name": "lastsuccessfuljob", + "type": "date" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "the time these statistics were collected", + "name": "collectiontime", + "type": "date" + }, + { + "description": "the last time this Usage Server checked for jobs", + "name": "lastheartbeat", + "type": "date" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + {}, + { + "description": "the state of the usage server", + "name": "state", + "type": "state" + }, + { + "description": "the name of the active usage server", + "name": "hostname", + "type": "string" } - ] + ], + "since": "4.17.0" }, { "description": "Lists physical networks", @@ -16580,11 +17188,20 @@ "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", + "length": 255, + "name": "id", + "related": "createPhysicalNetwork,listPhysicalNetworks,updatePhysicalNetwork", + "required": false, + "type": "uuid" }, { "description": "search by name", @@ -16596,96 +17213,87 @@ { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, { - "description": "the Zone ID for the physical network", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": false, - "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": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" } ], "related": "createPhysicalNetwork,updatePhysicalNetwork", "response": [ - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - {}, - { - "description": "isolation methods", - "name": "isolationmethods", - "type": "string" - }, { "description": "comma separated tag", "name": "tags", "type": "string" }, { - "description": "the uuid of the physical network", - "name": "id", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "name of the physical network", "name": "name", "type": "string" }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, { "description": "Broadcast domain range of the physical network", "name": "broadcastdomainrange", "type": "string" }, { - "description": "zone id of the physical network", - "name": "zoneid", + "description": "zone name of the physical network", + "name": "zonename", "type": "string" }, { - "description": "the vlan of the physical network", - "name": "vlan", + "description": "the domain id of the physical network owner", + "name": "domainid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "state of the physical network", + "name": "state", + "type": "string" }, { - "description": "the domain id of the physical network owner", - "name": "domainid", + "description": "zone id of the physical network", + "name": "zoneid", "type": "string" }, { - "description": "zone name of the physical network", - "name": "zonename", + "description": "the vlan of the physical network", + "name": "vlan", "type": "string" }, + {}, + {}, { - "description": "state of the physical network", - "name": "state", + "description": "the uuid of the physical network", + "name": "id", + "type": "string" + }, + { + "description": "isolation methods", + "name": "isolationmethods", "type": "string" }, { @@ -16711,6 +17319,17 @@ } ], "response": [ + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + }, + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", @@ -16721,18 +17340,7 @@ "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" }, @@ -16745,42 +17353,52 @@ "description": "Lists rule with the specified ID.", "length": 255, "name": "id", - "related": "createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules", + "related": "createIpv6FirewallRule,listIpv6FirewallRules,updateIpv6FirewallRule,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules", "required": false, "type": "uuid" }, { - "description": "", + "description": "List resources by tags (key/value pairs)", "length": 255, - "name": "pagesize", + "name": "tags", "required": false, - "type": "integer" + "type": "map" }, { - "description": "List by keyword", + "description": "list firewall rules for certain network", "length": 255, - "name": "keyword", + "name": "networkid", + "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listSrxFirewallNetworks,listBrocadeVcsDeviceNetworks", "required": false, - "type": "string" + "since": "4.3", + "type": "uuid" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false", + "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 resources by account. Must be used with the domainId parameter.", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "account", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", "required": false, - "type": "string" + "type": "uuid" }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, @@ -16793,35 +17411,33 @@ "type": "boolean" }, { - "description": "list only resources belonging to the domain specified", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", + "name": "isrecursive", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "list firewall rules for certain network", + "description": "List by keyword", "length": 255, - "name": "networkid", - "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listF5LoadBalancerNetworks,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listSrxFirewallNetworks,listBrocadeVcsDeviceNetworks", + "name": "keyword", "required": false, - "since": "4.3", - "type": "uuid" + "type": "string" }, { - "description": "List resources by tags (key/value pairs)", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "tags", + "name": "account", "required": false, - "type": "map" + "type": "string" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "isrecursive", + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", "required": false, - "type": "boolean" + "type": "uuid" }, { "description": "the ID of IP address of the firewall services", @@ -16830,90 +17446,57 @@ "related": "associateIpAddress,listPublicIpAddresses,updateIpAddress,associateIpAddress,listPublicIpAddresses", "required": false, "type": "uuid" - }, - { - "description": "list objects by project", - "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", - "required": false, - "type": "uuid" } ], "related": "createFirewallRule,updateEgressFirewallRule", "response": [ { - "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 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 protocol of the firewall rule", + "name": "protocol", "type": "string" }, - {}, { - "description": "the ID of the firewall rule", - "name": "id", + "description": "the traffic type for the firewall rule", + "name": "traffictype", "type": "string" }, - { - "description": "error code for this icmp message", - "name": "icmpcode", - "type": "integer" - }, - {}, { "description": "the ending port of firewall rule's port range", "name": "endport", "type": "integer" }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the state of the rule", - "name": "state", - "type": "string" - }, { "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", "name": "cidrlist", "type": "string" }, + {}, { - "description": "the cidr list to forward traffic to. Multiple entries are separated by a single comma character (,).", - "name": "destcidrlist", - "type": "string" - }, - { - "description": "type of the icmp message being sent", - "name": "icmptype", - "type": "integer" + "description": "is rule for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, { - "description": "the network id of the firewall rule", - "name": "networkid", + "description": "the ID of the firewall rule", + "name": "id", "type": "string" }, { - "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" }, { - "description": "the starting port of firewall rule's port range", - "name": "startport", + "description": "error code for this icmp message", + "name": "icmpcode", "type": "integer" }, + {}, { "description": "the public ip address id for the firewall rule", "name": "ipaddressid", @@ -16923,6 +17506,16 @@ "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, { "description": "the project name where tag belongs to", "name": "project", @@ -16934,23 +17527,23 @@ "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "tag key name", + "name": "key", "type": "string" }, { @@ -16962,19 +17555,39 @@ "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" } ], "type": "list" + }, + { + "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 public ip address for the firewall rule", + "name": "ipaddress", + "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 current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ] }, @@ -16984,23 +17597,23 @@ "name": "cleanVMReservations", "params": [], "response": [ - {}, - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - }, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, + {}, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, + {}, + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", @@ -17024,26 +17637,26 @@ ], "response": [ { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, {}, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" } ] }, @@ -17052,13 +17665,6 @@ "isasync": true, "name": "extractIso", "params": [ - { - "description": "the mode of extraction - HTTP_DOWNLOAD or FTP_UPLOAD", - "length": 255, - "name": "mode", - "required": true, - "type": "string" - }, { "description": "the ID of the zone where the ISO is originally located", "length": 255, @@ -17068,12 +17674,11 @@ "type": "uuid" }, { - "description": "the ID of the ISO file", + "description": "the mode of extraction - HTTP_DOWNLOAD or FTP_UPLOAD", "length": 255, - "name": "id", - "related": "prepareTemplate,listIsos,registerIso,updateIso,copyTemplate,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", + "name": "mode", "required": true, - "type": "uuid" + "type": "string" }, { "description": "the URL to which the ISO would be extracted", @@ -17081,33 +17686,58 @@ "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", + "required": true, + "type": "uuid" } ], "related": "extractTemplate,extractVolume", "response": [ { - "description": "the state of the extracted object", - "name": "state", + "description": "type of the storage", + "name": "storagetype", + "type": "string" + }, + { + "description": "the name of the extracted object", + "name": "name", + "type": "string" + }, + { + "description": "the mode of extraction - upload or download", + "name": "extractMode", "type": "string" }, + {}, { "description": "", "name": "resultstring", "type": "string" }, { - "description": "zone ID the object was extracted from", - "name": "zoneid", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {}, + { + "description": "the account id to which the extracted object belongs", + "name": "accountid", "type": "string" }, { - "description": "the status of the extraction", - "name": "status", + "description": "zone ID the object was extracted from", + "name": "zoneid", "type": "string" }, { - "description": "the id of extracted object", - "name": "id", + "description": "zone name the object was extracted from", + "name": "zonename", "type": "string" }, { @@ -17116,55 +17746,38 @@ "type": "string" }, { - "description": "the name of the extracted object", - "name": "name", + "description": "the status of the extraction", + "name": "status", "type": "string" }, { - "description": "the account id to which the extracted object belongs", - "name": "accountid", - "type": "string" + "description": "the percentage of the entity uploaded to the specified location", + "name": "uploadpercentage", + "type": "integer" }, { - "description": "zone name the object was extracted from", - "name": "zonename", + "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": "type of the storage", - "name": "storagetype", - "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 mode of extraction - upload or download", - "name": "extractMode", + "description": "if mode = upload then url of the uploaded entity. if mode = download the url from which the entity can be downloaded", + "name": "url", "type": "string" }, - {}, - { - "description": "the percentage of the entity uploaded to the specified location", - "name": "uploadpercentage", - "type": "integer" - }, { - "description": "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 id of extracted object", + "name": "id", "type": "string" } ] @@ -17175,19 +17788,18 @@ "name": "createSecondaryStagingStore", "params": [ { - "description": "the Zone ID for the staging store", + "description": "the scope of the staging store: zone only for now", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "scope", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "the 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 URL for the staging store", @@ -17197,93 +17809,94 @@ "type": "string" }, { - "description": "the scope of the staging store: zone only for now", + "description": "the Zone ID for the staging store", "length": 255, - "name": "scope", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, - "type": "string" + "type": "uuid" }, { - "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" } ], "related": "addSecondaryStorage,listSwifts,updateImageStore,addImageStore,addImageStoreS3,listImageStores,updateCloudToUseObjectStore", "response": [ { - "description": "the provider name of the image store", - "name": "providername", + "description": "the Zone ID of the image store", + "name": "zoneid", "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 total disk size of the host", - "name": "disksizetotal", - "type": "long" - }, - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the ID of the image store", - "name": "id", - "type": "string" - }, - {}, - { - "description": "the name of the image store", - "name": "name", + "description": "the protocol of the image store", + "name": "protocol", "type": "string" }, - { - "description": "the scope of the image store", - "name": "scope", - "type": "scopetype" - }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + {}, { "description": "the Zone name of the image store", "name": "zonename", "type": "string" }, + { + "description": "the host's currently used disk size", + "name": "disksizeused", + "type": "long" + }, { "description": "the url of the image store", "name": "url", "type": "string" }, { - "description": "the protocol of the image store", - "name": "protocol", - "type": "string" + "description": "the total disk size of the host", + "name": "disksizetotal", + "type": "long" }, { - "description": "the Zone ID of the image store", - "name": "zoneid", + "description": "the ID of the image store", + "name": "id", "type": "string" }, + {}, { - "description": "defines if store is read-only", - "name": "readonly", + "description": "the scope of the image store", + "name": "scope", + "type": "scopetype" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "the host's currently used disk size", - "name": "disksizeused", - "type": "long" + "description": "the provider name of the image store", + "name": "providername", + "type": "string" + }, + { + "description": "the name of the image store", + "name": "name", + "type": "string" } ] }, @@ -17293,10 +17906,10 @@ "name": "createAffinityGroup", "params": [ { - "description": "an account for the affinity group. Must be used with domainId.", + "description": "Type of the affinity group from the available affinity/anti-affinity group types", "length": 255, - "name": "account", - "required": false, + "name": "type", + "required": true, "type": "string" }, { @@ -17308,17 +17921,16 @@ "type": "uuid" }, { - "description": "create affinity group for project", + "description": "an account for the affinity group. 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": "Type of the affinity group from the available affinity/anti-affinity group types", + "description": "name of the affinity group", "length": 255, - "name": "type", + "name": "name", "required": true, "type": "string" }, @@ -17330,29 +17942,29 @@ "type": "string" }, { - "description": "name of the affinity group", + "description": "create affinity group for project", "length": 255, - "name": "name", - "required": true, - "type": "string" + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "required": false, + "type": "uuid" } ], "related": "", "response": [ - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the project ID of the affinity group", + "name": "projectid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the project name of the affinity group", + "name": "project", + "type": "string" }, { - "description": "the name of the affinity group", - "name": "name", + "description": "the ID of the affinity group", + "name": "id", "type": "string" }, { @@ -17361,25 +17973,20 @@ "type": "string" }, { - "description": "the ID of the affinity group", - "name": "id", + "description": "the account owning the affinity group", + "name": "account", "type": "string" }, - { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" - }, {}, { - "description": "the project ID of the affinity group", - "name": "projectid", + "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 current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "the description of the affinity group", @@ -17387,18 +17994,24 @@ "type": "string" }, { - "description": "the account owning the affinity group", - "name": "account", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the domain ID of the affinity group", - "name": "domainid", + "description": "the type of the affinity group", + "name": "type", "type": "string" }, { - "description": "the type of the affinity group", - "name": "type", + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" + }, + {}, + { + "description": "the name of the affinity group", + "name": "name", "type": "string" } ] @@ -17419,26 +18032,26 @@ ], "response": [ {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" }, - {}, { "description": "the UUID of the latest async job acting on 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" } ] }, @@ -17448,25 +18061,24 @@ "name": "listInternalLoadBalancerElements", "params": [ { - "description": "list internal load balancer elements by network service provider id", + "description": "", "length": 255, - "name": "nspid", - "related": "addNetworkServiceProvider,listNetworkServiceProviders,updateNetworkServiceProvider,listTrafficTypes", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "List by keyword", + "description": "list internal load balancer elements by enabled state", "length": 255, - "name": "keyword", + "name": "enabled", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "list internal load balancer elements by id", + "description": "list internal load balancer elements by network service provider id", "length": 255, - "name": "id", - "related": "configureInternalLoadBalancerElement,createInternalLoadBalancerElement,listInternalLoadBalancerElements", + "name": "nspid", + "related": "addNetworkServiceProvider,listNetworkServiceProviders,updateNetworkServiceProvider,listTrafficTypes", "required": false, "type": "uuid" }, @@ -17478,39 +18090,40 @@ "type": "integer" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "pagesize", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { - "description": "list internal load balancer elements by enabled state", + "description": "list internal load balancer elements by id", "length": 255, - "name": "enabled", + "name": "id", + "related": "configureInternalLoadBalancerElement,createInternalLoadBalancerElement,listInternalLoadBalancerElements", "required": false, - "type": "boolean" + "type": "uuid" } ], "related": "configureInternalLoadBalancerElement,createInternalLoadBalancerElement", "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 UUID of the latest async job acting on 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 internal load balancer element", "name": "id", @@ -17529,6 +18142,14 @@ "isasync": true, "name": "updateLBHealthCheckPolicy", "params": [ + { + "description": "ID of load balancer health check policy", + "length": 255, + "name": "id", + "related": "createLBHealthCheckPolicy,listLBHealthCheckPolicies,updateLBHealthCheckPolicy", + "required": true, + "type": "uuid" + }, { "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", "length": 255, @@ -17544,57 +18165,65 @@ "required": false, "since": "4.4", "type": "boolean" - }, - { - "description": "ID of load balancer health check policy", - "length": 255, - "name": "id", - "related": "createLBHealthCheckPolicy,listLBHealthCheckPolicies,updateLBHealthCheckPolicy", - "required": true, - "type": "uuid" } ], "related": "createLBHealthCheckPolicy,listLBHealthCheckPolicies", "response": [ { - "description": "the domain ID of the HealthCheck policy", - "name": "domainid", + "description": "the domain of the HealthCheck policy", + "name": "domain", + "type": "string" + }, + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the 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 list of healthcheckpolicies", "name": "healthcheckpolicy", "response": [ { - "description": "the LB HealthCheck policy ID", - "name": "id", + "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 state of the policy", - "name": "state", + "description": "the pingpath of the healthcheck policy", + "name": "pingpath", "type": "string" }, { - "description": "Number of consecutive health check failures before declaring an instance unhealthy.", - "name": "unhealthcheckthresshold", + "description": "Time to wait when receiving a response from the health check", + "name": "responsetime", "type": "int" }, { - "description": "the description of the healthcheck policy", - "name": "description", - "type": "string" + "description": "Number of consecutive health check failures before declaring an instance unhealthy.", + "name": "unhealthcheckthresshold", + "type": "int" }, { - "description": "Amount of time between health checks", - "name": "healthcheckinterval", - "type": "int" + "description": "is policy for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, { "description": "Number of consecutive health check success before declaring an instance healthy", @@ -17602,48 +18231,32 @@ "type": "int" }, { - "description": "the pingpath of the healthcheck policy", - "name": "pingpath", + "description": "the LB HealthCheck policy ID", + "name": "id", "type": "string" }, { - "description": "Time to wait when receiving a response from the health check", - "name": "responsetime", - "type": "int" + "description": "the state of the policy", + "name": "state", + "type": "string" } ], "type": "list" }, { - "description": "the LB rule ID", - "name": "lbruleid", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the domain ID of the HealthCheck policy", + "name": "domainid", "type": "string" }, { - "description": "the domain of the HealthCheck policy", - "name": "domain", + "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 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" } ], "since": "4.4" @@ -17653,14 +18266,6 @@ "isasync": true, "name": "rebootVirtualMachine", "params": [ - { - "description": "Force reboot the VM (VM is Stopped and then Started)", - "length": 255, - "name": "forced", - "required": false, - "since": "4.16.0", - "type": "boolean" - }, { "description": "Boot into hardware setup menu or not", "length": 255, @@ -17676,241 +18281,148 @@ "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,revertToVMSnapshot,updateVmNicIp,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance", "required": true, "type": "uuid" + }, + { + "description": "Force reboot the VM (VM is Stopped and then Started)", + "length": 255, + "name": "forced", + "required": false, + "since": "4.16.0", + "type": "boolean" } ], "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,revertToVMSnapshot,updateVmNicIp,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance", "response": [ { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", - "type": "string" - }, - { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" - }, - { - "description": "the 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": "the ID of the disk offering of the virtual machine", - "name": "diskofferingid", - "type": "string" - }, - { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" - }, - { - "description": "the target memory in vm", - "name": "memorytargetkbs", - "type": "long" + "description": "the name of the host for the virtual machine", + "name": "hostname", + "type": "string" }, { - "description": "device type of the root volume", - "name": "rootdevicetype", + "description": "the pool type of the virtual machine", + "name": "pooltype", "type": "string" }, { - "description": "the group ID of the virtual machine", - "name": "groupid", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", + "description": "the list of resource tags associated", + "name": "tags", "response": [ { - "description": "the domain name of the affinity group", - "name": "domain", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the description of the affinity group", - "name": "description", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the account owning the affinity group", - "name": "account", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the ID of the affinity group", - "name": "id", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the 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": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the type of the affinity group", - "name": "type", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the name of the affinity group", - "name": "name", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" + "description": "tag value", + "name": "value", + "type": "string" }, { - "description": "the project ID of the affinity group", - "name": "projectid", + "description": "resource type", + "name": "resourcetype", "type": "string" } ], "type": "set" }, { - "description": "the name of the disk offering of the virtual machine", - "name": "diskofferingname", - "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": "public IP address id associated with vm via Static nat rule", - "name": "publicip", - "type": "string" - }, - { - "description": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - {}, - { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "Guest vm Boot Type", - "name": "boottype", + "description": "Os type ID of the virtual machine", + "name": "guestosid", "type": "string" }, - { - "description": "the number of cpu this virtual machine is running with", - "name": "cpunumber", - "type": "integer" - }, { "description": "the list of nics associated with vm", "name": "nic", "response": [ { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" - }, - { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", - "type": "string" - }, - { - "description": "the type of the nic", - "name": "type", - "type": "string" - }, - { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", "type": "string" }, { "description": "true if nic is default, false otherwise", - "name": "macaddress", - "type": "string" - }, - { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "the traffic type of the nic", - "name": "traffictype", - "type": "string" - }, - { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", - "type": "string" + "name": "isdefault", + "type": "boolean" }, { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "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", + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", "type": "integer" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", "type": "string" }, { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", "type": "list" }, { - "description": "the netmask of the nic", - "name": "netmask", + "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": "true if nic is default, false otherwise", + "name": "macaddress", "type": "string" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", - "type": "string" + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" }, { "description": "the gateway of the nic", @@ -17918,28 +18430,23 @@ "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 broadcast uri of the nic", + "name": "broadcasturi", "type": "string" }, { - "description": "the ID of the nic", - "name": "id", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", "type": "string" }, { - "description": "the IPv6 address of network", - "name": "ip6address", + "description": "the traffic type of the nic", + "name": "traffictype", "type": "string" }, { @@ -17948,308 +18455,132 @@ "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", + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", "type": "integer" }, { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "the isolation uri of the nic", + "name": "isolationuri", "type": "string" - } - ], - "type": "set" - }, - { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", - "type": "string" - }, - { - "description": "the name of the template for the virtual machine", - "name": "templatename", - "type": "string" - }, - { - "description": "Guest vm Boot Mode", - "name": "bootmode", - "type": "string" - }, - { - "description": "the write (bytes) of disk on the vm", - "name": "diskkbswrite", - "type": "long" - }, - { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" - }, - { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" - }, - { - "description": "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": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", - "type": "boolean" - }, - { - "description": "the read (bytes) of disk on the vm", - "name": "diskkbsread", - "type": "long" - }, - { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" - }, - { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", - "type": "string" - }, - { - "description": "the memory used by the vm", - "name": "memorykbs", - "type": "long" - }, - { - "description": "the ID of the host for the virtual machine", - "name": "hostid", - "type": "string" - }, - {}, - { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", - "type": "string" - }, - { - "description": "the name of the host for the virtual machine", - "name": "hostname", - "type": "string" - }, - { - "description": "the name of the virtual machine", - "name": "name", - "type": "string" - }, - { - "description": "the state of the virtual machine", - "name": "state", - "type": "string" - }, - { - "description": "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 hypervisor on which the template runs", - "name": "hypervisor", - "type": "string" - }, - { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", - "type": "string" - }, - { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", - "type": "string" - }, - { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" - }, - { - "description": "the write (io) of disk on the vm", - "name": "diskiowrite", - "type": "long" - }, - { - "description": "the project name of the vm", - "name": "project", - "type": "string" - }, - { - "description": "the password (if exists) of the virtual machine", - "name": "password", - "type": "string" - }, - { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", - "type": "boolean" - }, - { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" - }, - { - "description": "OS type id of the vm", - "name": "ostypeid", - "type": "string" - }, - { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", - "type": "string" - }, - { - "description": "the outgoing network traffic on the host", - "name": "networkkbswrite", - "type": "long" - }, - { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", - "type": "string" - }, - { - "description": "the list of resource tags associated", - "name": "tags", - "response": [ + }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the type of the nic", + "name": "type", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", - "type": "string" + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" }, { - "description": "tag key name", - "name": "key", + "description": "the ID of the nic", + "name": "id", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the ID of the corresponding network", + "name": "networkid", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the netmask of the nic", + "name": "netmask", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the name of the corresponding network", + "name": "networkname", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" } ], "type": "set" }, - { - "description": "Os type ID of the virtual machine", - "name": "guestosid", - "type": "string" - }, - { - "description": "State of the Service from LB rule", - "name": "servicestate", - "type": "string" - }, - { - "description": "the incoming network traffic on the vm", - "name": "networkkbsread", - "type": "long" - }, - { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", - "type": "string" - }, - { - "description": "the account associated with the virtual machine", - "name": "account", - "type": "string" - }, - { - "description": "ssh key-pair", - "name": "keypair", - "type": "string" - }, { "description": "the name of the backup offering of the virtual machine", "name": "backupofferingname", "type": "string" }, - { - "description": "the project id of the vm", - "name": "projectid", - "type": "string" - }, - { - "description": "the read (io) of disk on the vm", - "name": "diskioread", - "type": "long" - }, - { - "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": "list of security groups associated with the virtual machine", "name": "securitygroup", "response": [ { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + } + ], "type": "set" }, { @@ -18258,23 +18589,8 @@ "type": "integer" }, { - "description": "the name of the security group", - "name": "name", - "type": "string" - }, - { - "description": "the project id of the group", - "name": "projectid", - "type": "string" - }, - { - "description": "the domain name of the security group", - "name": "domain", - "type": "string" - }, - { - "description": "the list of egress rules associated with the security group", - "name": "egressrule", + "description": "the list of ingress rules associated with the security group", + "name": "ingressrule", "response": [ { "description": "the protocol of the security group rule", @@ -18282,29 +18598,44 @@ "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 type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, { "description": "account owning the security group rule", "name": "account", "type": "string" }, + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, { "description": "tag value", "name": "value", @@ -18321,18 +18652,23 @@ "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { @@ -18346,37 +18682,17 @@ "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "customer associated with the tag", + "name": "customer", "type": "string" } ], "type": "set" }, - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, { "description": "the 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 type of the ICMP message response", - "name": "icmptype", - "type": "integer" } ], "type": "set" @@ -18387,28 +18703,33 @@ "type": "string" }, { - "description": "the description of the security group", - "name": "description", + "description": "the ID of the security group", + "name": "id", "type": "string" }, { - "description": "the account owning the security group", - "name": "account", + "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 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 id of the security group rule", - "name": "ruleid", + "description": "security group name", + "name": "securitygroupname", "type": "string" }, { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" }, { "description": "account owning the security group rule", @@ -18416,9 +18737,9 @@ "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", @@ -18426,13 +18747,8 @@ "type": "string" }, { - "description": "security group name", - "name": "securitygroupname", - "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" }, { @@ -18440,63 +18756,68 @@ "name": "tags", "response": [ { - "description": "id of the resource", - "name": "resourceid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "resource type", + "name": "resourcetype", "type": "string" } ], "type": "set" }, { - "description": "the code for the ICMP message response", - "name": "icmpcode", + "description": "the type of the ICMP message response", + "name": "icmptype", "type": "integer" }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, { "description": "the starting IP of the security group rule", "name": "startport", @@ -18505,131 +18826,433 @@ ], "type": "set" }, + { + "description": "the account owning the security group", + "name": "account", + "type": "string" + }, { "description": "the domain ID of the security group", "name": "domainid", "type": "string" }, { - "description": "the ID of the security group", - "name": "id", + "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": "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 value", - "name": "value", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - } - ], + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", "type": "set" + }, + { + "description": "the project id of the group", + "name": "projectid", + "type": "string" } ], "type": "set" }, { - "description": "the speed of each cpu", - "name": "cpuspeed", + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", + "type": "string" + }, + { + "description": "Guest vm Boot Type", + "name": "boottype", + "type": "string" + }, + { + "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", + "type": "long" + }, + { + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", + "type": "string" + }, + { + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" + }, + { + "description": "the account associated with the virtual machine", + "name": "account", + "type": "string" + }, + { + "description": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" + }, + { + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" + }, + { + "description": "the project id of the vm", + "name": "projectid", + "type": "string" + }, + { + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" + }, + { + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" + }, + { + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", + "type": "string" + }, + { + "description": "the read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" + }, + { + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" + }, + { + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" + }, + { + "description": "State of the Service from LB rule", + "name": "servicestate", + "type": "string" + }, + { + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" + }, + { + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" + }, + { + "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": "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 service offering of the virtual machine", + "name": "serviceofferingname", + "type": "string" + }, + { + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", + "type": "string" + }, + { + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", + "type": "string" + }, + { + "description": "the group name of the virtual machine", + "name": "group", + "type": "string" + }, + { + "description": "OS name of the vm", + "name": "osdisplayname", + "type": "string" + }, + { + "description": "the password (if exists) of the virtual machine", + "name": "password", + "type": "string" + }, + { + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", + "type": "string" + }, + { + "description": "the user's ID who deployed the virtual machine", + "name": "userid", + "type": "string" + }, + { + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", + "type": "string" + }, + { + "description": "ssh key-pairs", + "name": "keypairs", + "type": "string" + }, + { + "description": "OS type id of the vm", + "name": "ostypeid", + "type": "string" + }, + { + "description": "device type of the root volume", + "name": "rootdevicetype", + "type": "string" + }, + { + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", + "type": "string" + }, + { + "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", + "type": "string" + }, + { + "description": "Guest vm Boot Mode", + "name": "bootmode", + "type": "string" + }, + { + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" + }, + { + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" + }, + { + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", + "type": "string" + }, + {}, + {}, + { + "description": "the memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" + }, + { + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", + "type": "string" + }, + { + "description": "the ID of the availablility zone for the virtual machine", + "name": "zoneid", + "type": "string" + }, + { + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", + "type": "string" + }, + { + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", + "type": "boolean" + }, + { + "description": "the project name of the vm", + "name": "project", + "type": "string" + }, + { + "description": "the group ID of the virtual machine", + "name": "groupid", + "type": "string" + }, + { + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", + "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": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", "type": "string" }, { - "description": "the internal memory that's free in vm or zero if it can not be calculated", - "name": "memoryintfreekbs", - "type": "long" + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" }, { - "description": "the ID of the availablility zone for the virtual machine", - "name": "zoneid", + "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 speed of each vCPU", + "name": "cpuspeed", + "type": "integer" + }, + { + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" + }, { "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", "name": "displayname", "type": "string" }, { - "description": "the pool type of the virtual machine", - "name": "pooltype", + "description": "the state of the virtual machine", + "name": "state", "type": "string" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", - "type": "string" + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" }, { - "description": "the ID of the virtual machine", - "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": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", + "description": "the name of the virtual machine", + "name": "name", "type": "string" }, - {}, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", "type": "string" }, { - "description": "OS name of the vm", - "name": "osdisplayname", - "type": "string" + "description": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", + "response": [ + { + "description": "the name of the affinity group", + "name": "name", + "type": "string" + }, + { + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" + }, + { + "description": "the domain ID of the affinity group", + "name": "domainid", + "type": "string" + }, + { + "description": "the ID of the affinity group", + "name": "id", + "type": "string" + }, + { + "description": "the domain name of the affinity group", + "name": "domain", + "type": "string" + }, + { + "description": "the account owning the affinity group", + "name": "account", + "type": "string" + }, + { + "description": "the description of the affinity group", + "name": "description", + "type": "string" + }, + { + "description": "the type of the affinity group", + "name": "type", + "type": "string" + }, + { + "description": "the project ID of the affinity group", + "name": "projectid", + "type": "string" + }, + { + "description": "the project name of the affinity group", + "name": "project", + "type": "string" + } + ], + "type": "set" } ] }, @@ -18648,6 +19271,17 @@ } ], "response": [ + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, + {}, { "description": "any text associated with the success or failure", "name": "displaytext", @@ -18658,17 +19292,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", - "type": "boolean" - }, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" } ], "since": "4.11" @@ -18679,26 +19302,18 @@ "name": "createLoadBalancerRule", "params": [ { - "description": "the account associated with the load balancer. Must be used with the domainId parameter.", - "length": 255, - "name": "account", - "required": false, - "type": "string" - }, - { - "description": "an optional field, whether to the display the rule to the end user or not", + "description": "the public port from where the network traffic will be load balanced from", "length": 255, - "name": "fordisplay", - "required": false, - "since": "4.4", - "type": "boolean" + "name": "publicport", + "required": true, + "type": "integer" }, { - "description": "if true, firewall rule for source/end public port is automatically created; if false - firewall rule has to be created explicitely. If not specified 1) defaulted to false when LB rule is being created for VPC guest network 2) in all other cases defaulted to true", + "description": "The protocol for the LB such as tcp, udp or tcp-proxy.", "length": 255, - "name": "openfirewall", + "name": "protocol", "required": false, - "type": "boolean" + "type": "string" }, { "description": "zone where the load balancer is going to be created. This parameter is required when LB service provider is ElasticLoadBalancerVm", @@ -18709,40 +19324,34 @@ "type": "uuid" }, { - "description": "load balancer algorithm (source, roundrobin, leastconn)", + "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": "algorithm", - "required": true, - "type": "string" + "name": "cidrlist", + "required": false, + "type": "list" }, { - "description": "the description of the load balancer rule", - "length": 4096, - "name": "description", + "description": "the domain ID associated with the load balancer", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "name of the load balancer rule", + "description": "the private port of the private IP address/virtual machine where the network traffic will be load balanced to", "length": 255, - "name": "name", + "name": "privateport", "required": true, - "type": "string" + "type": "integer" }, { - "description": "The protocol for the LB such as tcp, udp or tcp-proxy.", - "length": 255, - "name": "protocol", + "description": "the description of the load balancer rule", + "length": 4096, + "name": "description", "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": "public IP address ID from where the network traffic will be load balanced from", "length": 255, @@ -18752,146 +19361,94 @@ "type": "uuid" }, { - "description": "the domain ID associated with the load balancer", - "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", - "required": false, - "type": "uuid" - }, - { - "description": "the public port from where the network traffic will be load balanced from", + "description": "name of the load balancer rule", "length": 255, - "name": "publicport", + "name": "name", "required": true, - "type": "integer" + "type": "string" }, { - "description": "the private port of the private IP address/virtual machine where the network traffic will be load balanced to", + "description": "if true, firewall rule for source/end public port is automatically created; if false - firewall rule has to be created explicitely. If not specified 1) defaulted to false when LB rule is being created for VPC guest network 2) in all other cases defaulted to true", "length": 255, - "name": "privateport", - "required": true, - "type": "integer" + "name": "openfirewall", + "required": false, + "type": "boolean" }, { "description": "The guest network this rule will be created for. Required when public Ip address is not associated with any Guest network yet (VPC case)", "length": 255, "name": "networkid", - "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listF5LoadBalancerNetworks,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listSrxFirewallNetworks,listBrocadeVcsDeviceNetworks", + "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listSrxFirewallNetworks,listBrocadeVcsDeviceNetworks", "required": false, "type": "uuid" - } - ], - "related": "listLoadBalancerRules,updateLoadBalancerRule", - "response": [ + }, { - "description": "the state of the rule", - "name": "state", + "description": "load balancer algorithm (source, roundrobin, leastconn)", + "length": 255, + "name": "algorithm", + "required": true, "type": "string" }, { - "description": "the project name of the load balancer", - "name": "project", + "description": "the account associated with the load balancer. Must be used with the domainId parameter.", + "length": 255, + "name": "account", + "required": false, "type": "string" }, { - "description": "is rule for display to the regular user", + "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 public ip address id", - "name": "publicipid", - "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 cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", - "type": "string" - }, - { - "description": "the domain of the load balancer rule", - "name": "domain", - "type": "string" - }, + } + ], + "related": "listLoadBalancerRules,updateLoadBalancerRule", + "response": [ { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - { - "description": "the name of the zone the load balancer rule belongs to", - "name": "zonename", - "type": "string" - }, - { - "description": "the public port", - "name": "publicport", - "type": "string" - }, - { - "description": "the domain ID of the load balancer rule", - "name": "domainid", - "type": "string" - }, - {}, - { - "description": "the project id of the load balancer", - "name": "projectid", - "type": "string" - }, - { - "description": "the load balancer rule ID", - "name": "id", - "type": "string" - }, { "description": "the list of resource tags associated with load balancer", "name": "tags", "response": [ { - "description": "customer associated with the tag", - "name": "customer", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the 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 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 project id the tag belongs to", - "name": "projectid", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { @@ -18900,37 +19457,57 @@ "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "customer associated with the tag", + "name": "customer", "type": "string" } ], "type": "list" }, { - "description": "the load balancer algorithm (source, roundrobin, leastconn)", - "name": "algorithm", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the project id of the load balancer", + "name": "projectid", "type": "string" }, { - "description": "the account of the load balancer rule", - "name": "account", + "description": "the public ip address id", + "name": "publicipid", "type": "string" }, { - "description": "the public ip address", - "name": "publicip", + "description": "is rule for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, + { + "description": "the public port", + "name": "publicport", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the protocol of the loadbalanacer rule", + "name": "protocol", + "type": "string" + }, + { + "description": "the project name of the load balancer", + "name": "project", + "type": "string" + }, + { + "description": "the state of the rule", + "name": "state", + "type": "string" }, { "description": "the description of the load balancer", @@ -18938,11 +19515,21 @@ "type": "string" }, { - "description": "the name of the load balancer", - "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 domain of the load balancer rule", + "name": "domain", + "type": "string" + }, + { + "description": "the load balancer algorithm (source, roundrobin, leastconn)", + "name": "algorithm", + "type": "string" + }, { "description": "the private port", "name": "privateport", @@ -18952,163 +19539,99 @@ "description": "the id of the guest network the lb rule belongs to", "name": "networkid", "type": "string" - } - ] - }, - { - "description": "Import vSphere storage policies", - "isasync": false, - "name": "importVsphereStoragePolicies", - "params": [ + }, { - "description": "ID of the zone", - "length": 255, + "description": "the id of the zone the rule belongs to", "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": false, - "type": "uuid" - } - ], - "related": "listVsphereStoragePolicies", - "response": [ - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "type": "string" }, - {}, { - "description": "the identifier of the Storage Policy in vSphere DataCenter", - "name": "policyid", + "description": "the name of the zone the load balancer rule belongs to", + "name": "zonename", "type": "string" }, {}, { - "description": "the ID of the Storage Policy", - "name": "id", + "description": "the name of the load balancer", + "name": "name", "type": "string" }, { - "description": "the ID of the Zone", - "name": "zoneid", + "description": "the public ip address", + "name": "publicip", "type": "string" }, { - "description": "the description of the Storage Policy", - "name": "description", + "description": "the domain ID of the load balancer rule", + "name": "domainid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the account of the load balancer rule", + "name": "account", "type": "string" }, { - "description": "the name of the Storage Policy", - "name": "name", + "description": "the load balancer rule ID", + "name": "id", "type": "string" } ] }, { - "description": "Lists backup offerings", + "description": "Import vSphere storage policies", "isasync": false, - "name": "listBackupOfferings", + "name": "importVsphereStoragePolicies", "params": [ { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - }, - { - "description": "The zone ID", + "description": "ID of the zone", "length": 255, "name": "zoneid", "related": "createZone,updateZone,listZones,listZones", "required": false, "type": "uuid" - }, - { - "description": "The backup offering ID", - "length": 255, - "name": "id", - "related": "listBackupProviderOfferings,importBackupOffering,listBackupOfferings,updateBackupOffering", - "required": false, - "type": "uuid" - }, - { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" } ], - "related": "listBackupProviderOfferings,importBackupOffering,updateBackupOffering", + "related": "listVsphereStoragePolicies", "response": [ - {}, - { - "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", - "type": "string" - }, - { - "description": "zone name", - "name": "zonename", - "type": "string" - }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the ID of the Storage Policy", + "name": "id", "type": "string" }, { - "description": "zone ID", - "name": "zoneid", + "description": "the identifier of the Storage Policy in vSphere DataCenter", + "name": "policyid", "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", + "description": "the ID of the Zone", + "name": "zoneid", "type": "string" }, { - "description": "ID of the backup offering", - "name": "id", + "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 name of the Storage Policy", + "name": "name", + "type": "string" }, { - "description": "whether offering allows user driven ad-hoc/scheduled backups", - "name": "allowuserdrivenbackups", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } - ], - "since": "4.14.0" + ] }, { "description": "Adds a guest OS name to hypervisor OS name mapping", @@ -19116,33 +19639,33 @@ "name": "addGuestOsMapping", "params": [ { - "description": "Hypervisor version to create the mapping for. Use 'default' for default versions", + "description": "UUID of Guest OS type. Either the UUID or Display Name must be passed", "length": 255, - "name": "hypervisorversion", - "required": true, - "type": "string" + "name": "ostypeid", + "related": "listOsTypes,addGuestOs", + "required": false, + "type": "uuid" }, { - "description": "Display Name of Guest OS standard type. Either Display Name or UUID must be passed", + "description": "OS name specific to the hypervisor", "length": 255, - "name": "osdisplayname", - "required": false, + "name": "osnameforhypervisor", + "required": true, "type": "string" }, { - "description": "OS name specific to the hypervisor", + "description": "Hypervisor version to create the mapping for. Use 'default' for default versions", "length": 255, - "name": "osnameforhypervisor", + "name": "hypervisorversion", "required": true, "type": "string" }, { - "description": "UUID of Guest OS type. Either the UUID or Display Name must be passed", + "description": "Display Name of Guest OS standard type. Either Display Name or UUID must be passed", "length": 255, - "name": "ostypeid", - "related": "listOsTypes,addGuestOs", + "name": "osdisplayname", "required": false, - "type": "uuid" + "type": "string" }, { "description": "Hypervisor type. One of : XenServer, KVM, VMWare", @@ -19155,41 +19678,34 @@ "related": "updateGuestOsMapping", "response": [ { - "description": "version of the hypervisor for mapping", - "name": "hypervisorversion", - "type": "string" - }, - {}, - { - "description": "is the mapping user defined", - "name": "isuserdefined", + "description": "standard display name for the Guest OS", + "name": "osdisplayname", "type": "string" }, - {}, { "description": "the hypervisor", "name": "hypervisor", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "is the mapping user defined", + "name": "isuserdefined", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the ID of the Guest OS type", + "name": "ostypeid", "type": "string" }, { - "description": "standard display name for the Guest OS", - "name": "osdisplayname", + "description": "version of the hypervisor for mapping", + "name": "hypervisorversion", "type": "string" }, { - "description": "the ID of the Guest OS type", - "name": "ostypeid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "the ID of the Guest OS mapping", @@ -19200,7 +19716,14 @@ "description": "hypervisor specific name for the Guest OS", "name": "osnameforhypervisor", "type": "string" - } + }, + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + {} ], "since": "4.4.0" }, @@ -19220,162 +19743,75 @@ ], "related": "enableOutOfBandManagementForHost,disableOutOfBandManagementForHost,enableOutOfBandManagementForCluster,disableOutOfBandManagementForCluster,enableOutOfBandManagementForZone,issueOutOfBandManagementPowerAction,changeOutOfBandManagementPassword", "response": [ - { - "description": "the out-of-band management interface username", - "name": "username", - "type": "string" - }, - { - "description": "the out-of-band management interface address", - "name": "address", - "type": "string" - }, - { - "description": "the operation result description", - "name": "description", - "type": "string" - }, - { - "description": "the out-of-band management interface port", - "name": "port", - "type": "string" - }, - {}, - { - "description": "the out-of-band management driver for the host", - "name": "driver", - "type": "string" - }, - { - "description": "true if out-of-band management is enabled for the host", - "name": "enabled", - "type": "boolean" - }, { "description": "the operation result", "name": "status", "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the out-of-band management interface port", + "name": "port", "type": "string" }, - { - "description": "the out-of-band management interface powerState of the host", - "name": "powerstate", - "type": "powerstate" - }, + {}, {}, { "description": "the out-of-band management interface password", "name": "password", "type": "string" }, - { - "description": "the ID of the host", - "name": "hostid", - "type": "string" - }, - { - "description": "the out-of-band management action (if issued)", - "name": "action", - "type": "string" - }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - } - ], - "since": "4.9.0" - }, - { - "description": "configures a F5 load balancer device", - "isasync": true, - "name": "configureF5LoadBalancer", - "params": [ - { - "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": "F5 load balancer device ID", - "length": 255, - "name": "lbdeviceid", - "related": "addF5LoadBalancer,configureF5LoadBalancer,listF5LoadBalancers", - "required": true, - "type": "uuid" - } - ], - "related": "addF5LoadBalancer,listF5LoadBalancers", - "response": [ - { - "description": "true if device is dedicated for an account", - "name": "lbdevicededicated", - "type": "boolean" }, { - "description": "the public interface of the load balancer", - "name": "publicinterface", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "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": "device name", - "name": "lbdevicename", + "description": "the out-of-band management action (if issued)", + "name": "action", "type": "string" }, { - "description": "device capacity", - "name": "lbdevicecapacity", - "type": "long" + "description": "true if out-of-band management is enabled for the host", + "name": "enabled", + "type": "boolean" }, { - "description": "device id of the F5 load balancer", - "name": "lbdeviceid", + "description": "the operation result description", + "name": "description", "type": "string" }, - {}, { - "description": "the management IP address of the external load balancer", - "name": "ipaddress", - "type": "string" + "description": "the out-of-band management interface powerState of the host", + "name": "powerstate", + "type": "powerstate" }, { - "description": "name of the provider", - "name": "provider", + "description": "the out-of-band management interface address", + "name": "address", "type": "string" }, { - "description": "device state", - "name": "lbdevicestate", + "description": "the out-of-band management driver for the host", + "name": "driver", "type": "string" }, { - "description": "the physical network to which this F5 device belongs to", - "name": "physicalnetworkid", + "description": "the out-of-band management interface username", + "name": "username", "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" } - ] + ], + "since": "4.9.0" }, { "description": "Updates a network offering.", @@ -19383,19 +19819,18 @@ "name": "updateNetworkOffering", "params": [ { - "description": "update state for the network offering", + "description": "sort key of the network offering, integer", "length": 255, - "name": "state", + "name": "sortkey", "required": false, - "type": "string" + "type": "integer" }, { - "description": "the ID of the containing zone(s) as comma separated string, all for all zones offerings", - "length": 4096, - "name": "zoneid", + "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, - "since": "4.13", - "type": "string" + "type": "boolean" }, { "description": "the name of the network offering", @@ -19405,38 +19840,40 @@ "type": "string" }, { - "description": "the ID of the containing domain(s) as comma separated string, public for public offerings", + "description": "the id of the network offering", "length": 255, - "name": "domainid", + "name": "id", + "related": "createNetworkOffering,updateNetworkOffering,listNetworkOfferings", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "the availability of network offering. Default value is Required for Guest Virtual network offering; Optional for Guest Direct network offering", + "description": "the display text of the network offering", "length": 255, - "name": "availability", + "name": "displaytext", "required": false, "type": "string" }, { - "description": "sort key of the network offering, integer", + "description": "the availability of network offering. Default value is Required for Guest Virtual network offering; Optional for Guest Direct network offering", "length": 255, - "name": "sortkey", + "name": "availability", "required": false, - "type": "integer" + "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": "update state for the network offering", "length": 255, - "name": "keepaliveenabled", + "name": "state", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "the display text of the network offering", - "length": 255, - "name": "displaytext", + "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" }, { @@ -19447,12 +19884,11 @@ "type": "integer" }, { - "description": "the id of the network offering", + "description": "the ID of the containing domain(s) as comma separated string, public for public offerings", "length": 255, - "name": "id", - "related": "createNetworkOffering,updateNetworkOffering,listNetworkOfferings", + "name": "domainid", "required": false, - "type": "uuid" + "type": "string" }, { "description": "the tags for the network offering.", @@ -19464,41 +19900,35 @@ ], "related": "createNetworkOffering,listNetworkOfferings", "response": [ + { + "description": "state of the network offering. Can be Disabled/Enabled/Inactive", + "name": "state", + "type": "string" + }, { "description": "true if network offering can be used by VPC networks only", "name": "forvpc", "type": "boolean" }, - {}, { - "description": "true if network offering supports public access for guest networks", - "name": "supportspublicaccess", + "description": "true if network offering is ip conserve mode enabled", + "name": "conservemode", "type": "boolean" }, { - "description": "data transfer rate in megabits per second allowed.", - "name": "networkrate", - "type": "integer" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "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": "an alternate display text of the network offering.", - "name": "displaytext", - "type": "string" + "description": "true if network offering supports network that span multiple zones", + "name": "supportsstrechedl2subnet", + "type": "boolean" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the date this network offering was created", + "name": "created", + "type": "date" }, { "description": "the list of supported services", @@ -19509,9 +19939,9 @@ "name": "capability", "response": [ { - "description": "can this service capability value can be choosable while creatine network offerings", - "name": "canchooseservicecapability", - "type": "boolean" + "description": "the capability name", + "name": "name", + "type": "string" }, { "description": "the capability value", @@ -19519,40 +19949,40 @@ "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", + "description": "the provider name", + "name": "name", "type": "string" }, { - "description": "state of the network provider", - "name": "state", + "description": "uuid of the network provider", + "name": "id", "type": "string" }, { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", + "description": "the destination physical network", + "name": "destinationphysicalnetworkid", "type": "string" }, { - "description": "the provider name", - "name": "name", + "description": "true if individual services can be enabled/disabled", + "name": "canenableindividualservice", + "type": "boolean" + }, + { + "description": "the physical network this belongs to", + "name": "physicalnetworkid", "type": "string" }, { @@ -19561,75 +19991,329 @@ "type": "list" }, { - "description": "true if individual services can be enabled/disabled", - "name": "canenableindividualservice", - "type": "boolean" - }, - { - "description": "uuid of the network provider", - "name": "id", + "description": "state of the network provider", + "name": "state", "type": "string" } ], "type": "list" + }, + { + "description": "the service name", + "name": "name", + "type": "string" } ], "type": "list" }, + { + "description": "the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "domain", + "type": "string" + }, + { + "description": "the tags for the network offering", + "name": "tags", + "type": "string" + }, + { + "description": "additional key/value details tied with network offering", + "name": "details", + "type": "map" + }, + { + "description": "the ID of the service offering used by virtual router provider", + "name": "serviceofferingid", + "type": "string" + }, + { + "description": "data transfer rate in megabits per second allowed.", + "name": "networkrate", + "type": "integer" + }, + { + "description": "the id of the network offering", + "name": "id", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "zone", + "type": "string" + }, + { + "description": "guest type of the network offering, can be Shared or Isolated", + "name": "guestiptype", + "type": "string" + }, { "description": "true if network offering supports persistent networks, false otherwise", "name": "ispersistent", "type": "boolean" }, + { + "description": "true if network offering is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "domainid", + "type": "string" + }, + { + "description": "availability of the network offering", + "name": "availability", + "type": "string" + }, + { + "description": "true if guest network default egress policy is allow; false if default egress policy is deny", + "name": "egressdefaultpolicy", + "type": "boolean" + }, + { + "description": "an alternate display text of the network offering.", + "name": "displaytext", + "type": "string" + }, + { + "description": "the traffic type for the network offering, supported types are Public, Management, Control, Guest, Vlan or Storage.", + "name": "traffictype", + "type": "string" + }, { "description": "true if network offering supports vlans, false otherwise", "name": "specifyvlan", "type": "boolean" }, { - "description": "guest type of the network offering, can be Shared or Isolated", - "name": "guestiptype", + "description": "maximum number of concurrents connections to be handled by lb", + "name": "maxconnections", + "type": "integer" + }, + { + "description": "true if network offering supports public access for guest networks", + "name": "supportspublicaccess", + "type": "boolean" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the name of the network offering", + "name": "name", "type": "string" }, {}, + {}, + { + "description": "true if network offering supports specifying ip ranges, false otherwise", + "name": "specifyipranges", + "type": "boolean" + }, + { + "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "zoneid", + "type": "string" + }, + { + "description": "the internet protocol of the network offering", + "name": "internetprotocol", + "type": "string" + } + ] + }, + { + "description": "Lists all IPv6 firewall rules", + "isasync": false, + "name": "listIpv6FirewallRules", + "params": [ + { + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "length": 255, + "name": "listall", + "required": false, + "type": "boolean" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "description": "list resources by account. Must be used with the domainId parameter.", + "length": 255, + "name": "account", + "required": false, + "type": "string" + }, + { + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "length": 255, + "name": "isrecursive", + "required": false, + "type": "boolean" + }, + { + "description": "Lists ipv6 firewall rule with the specified ID", + "length": 255, + "name": "id", + "related": "createIpv6FirewallRule,listIpv6FirewallRules,updateIpv6FirewallRule,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules", + "required": false, + "type": "uuid" + }, + { + "description": "List resources by tags (key/value pairs)", + "length": 255, + "name": "tags", + "required": false, + "type": "map" + }, + { + "description": "list objects by project; if projectid=-1 lists All VMs", + "length": 255, + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "required": false, + "type": "uuid" + }, + { + "description": "list ipv6 firewall rules by network ID", + "length": 255, + "name": "networkid", + "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listSrxFirewallNetworks,listBrocadeVcsDeviceNetworks", + "required": false, + "type": "uuid" + }, { - "description": "true if network offering supports network that span multiple zones", - "name": "supportsstrechedl2subnet", + "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "length": 255, + "name": "fordisplay", + "required": false, "type": "boolean" }, { - "description": "true if network offering is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" }, { - "description": "the traffic type for the network offering, supported types are Public, Management, Control, Guest, Vlan or Storage.", + "description": "list ipv6 firewall rules by traffic type - ingress or egress", + "length": 255, "name": "traffictype", + "required": false, "type": "string" }, { - "description": "the tags for the network offering", - "name": "tags", + "description": "list only resources belonging to the domain specified", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", + "required": false, + "type": "uuid" + } + ], + "related": "createIpv6FirewallRule,updateIpv6FirewallRule,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules", + "response": [ + { + "description": "the ID of the port forwarding rule", + "name": "id", "type": "string" }, + {}, { - "description": "true if guest network default egress policy is allow; false if default egress policy is deny", - "name": "egressdefaultpolicy", - "type": "boolean" + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + } + ], + "type": "list" }, { - "description": "maximum number of concurrents connections to be handled by lb", - "name": "maxconnections", - "type": "integer" + "description": "the public ip address id for the port forwarding rule", + "name": "ipaddressid", + "type": "string" }, { - "description": "true if network offering supports specifying ip ranges, false otherwise", - "name": "specifyipranges", - "type": "boolean" + "description": "the starting port of port forwarding rule's public port range", + "name": "publicport", + "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 state of the rule", + "name": "state", + "type": "string" + }, + { + "description": "the ending port of port forwarding rule's private port range", + "name": "privateendport", "type": "string" }, { @@ -19638,109 +20322,73 @@ "type": "integer" }, { - "description": "the date this network offering was created", - "name": "created", - "type": "date" - }, - { - "description": "additional key/value details tied with network offering", - "name": "details", - "type": "map" - }, - { - "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zoneid", + "description": "the protocol of the port forwarding rule", + "name": "protocol", "type": "string" }, { - "description": "availability of the network offering", - "name": "availability", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the id of the network offering", - "name": "id", + "description": "the id of the guest network the port forwarding rule belongs to", + "name": "networkid", "type": "string" }, { - "description": "state of the network offering. Can be Disabled/Enabled/Inactive", - "name": "state", + "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", "type": "string" }, { - "description": "the ID of the service offering used by virtual router provider", - "name": "serviceofferingid", + "description": "the starting port of port forwarding rule's private port range", + "name": "privateport", "type": "string" }, { - "description": "the name of the network offering", - "name": "name", - "type": "string" + "description": "is firewall for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, { - "description": "true if network offering is ip conserve mode enabled", - "name": "conservemode", - "type": "boolean" + "description": "the ending port of port forwarding rule's private port range", + "name": "publicendport", + "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 vm ip address for the port forwarding rule", + "name": "vmguestip", "type": "string" - } - ] - }, - { - "description": "Create VM backup", - "isasync": true, - "name": "createBackup", - "params": [ + }, + {}, { - "description": "ID of the VM", - "length": 255, + "description": "the VM ID for the port forwarding rule", "name": "virtualmachineid", - "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,revertToVMSnapshot,updateVmNicIp,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance", - "required": true, - "type": "uuid" - } - ], - "response": [ - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "type": "string" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the public ip address for the port forwarding rule", + "name": "ipaddress", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the VM display name for the port forwarding rule", + "name": "virtualmachinedisplayname", + "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the VM name for the port forwarding rule", + "name": "virtualmachinename", "type": "string" - }, - {} - ], - "since": "4.14.0" + } + ] }, { "description": "Stops a system VM.", "isasync": true, "name": "stopSystemVm", "params": [ - { - "description": "Force stop the VM. The caller knows the VM is stopped.", - "length": 255, - "name": "forced", - "required": false, - "type": "boolean" - }, { "description": "The ID of the system virtual machine", "length": 255, @@ -19748,13 +20396,30 @@ "related": "listSystemVms,migrateSystemVm,startSystemVm,stopSystemVm,changeServiceForSystemVm", "required": true, "type": "uuid" + }, + { + "description": "Force stop the VM. The caller knows the VM is stopped.", + "length": 255, + "name": "forced", + "required": false, + "type": "boolean" } ], "related": "listSystemVms,migrateSystemVm,startSystemVm,changeServiceForSystemVm", "response": [ { - "description": "the Zone name for the system VM", - "name": "zonename", + "description": "the job ID associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job.", + "name": "jobid", + "type": "string" + }, + { + "description": "the public MAC address for the system VM", + "name": "publicmacaddress", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -19763,94 +20428,108 @@ "type": "string" }, { - "description": "the public IP address for the system VM", - "name": "publicip", + "description": "the link local MAC address for the system vm", + "name": "linklocalmacaddress", "type": "string" }, { - "description": "the state of the system VM", - "name": "state", + "description": "the private MAC address for the system VM", + "name": "privatemacaddress", "type": "string" }, { - "description": "the link local IP address for the system vm", - "name": "linklocalip", + "description": "the network domain for the system VM", + "name": "networkdomain", "type": "string" }, { - "description": "the second DNS for the system VM", - "name": "dns2", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the system VM type", - "name": "systemvmtype", + "description": "the systemvm agent version", + "name": "version", "type": "string" }, { - "description": "the Zone ID for the system VM", - "name": "zoneid", + "description": "the template ID for the system VM", + "name": "templateid", "type": "string" }, { - "description": "the private MAC address for the system VM", - "name": "privatemacaddress", + "description": "the template name for the system VM", + "name": "templatename", "type": "string" }, { - "description": "the private netmask for the system VM", - "name": "privatenetmask", + "description": "the first DNS for the system VM", + "name": "dns1", "type": "string" }, { - "description": "the 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 state of the system VM", + "name": "state", "type": "string" }, { - "description": "the name of the system VM", - "name": "name", + "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 Zone name for the system VM", + "name": "zonename", "type": "string" }, { - "description": "guest vlan range", - "name": "guestvlan", + "description": "the second DNS for the system VM", + "name": "dns2", "type": "string" }, { - "description": "the public netmask for the system VM", - "name": "publicnetmask", + "description": "the public IP address for the system VM", + "name": "publicip", "type": "string" }, { - "description": "the ID of the system VM", - "name": "id", - "type": "string" + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" }, { - "description": "the template ID for the system VM", - "name": "templateid", + "description": "the private IP address for the system VM", + "name": "privateip", "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 Zone ID for the system VM", + "name": "zoneid", "type": "string" }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, { "description": "the link local netmask for the system vm", "name": "linklocalnetmask", "type": "string" }, - {}, { - "description": "the link local MAC address for the system vm", - "name": "linklocalmacaddress", + "description": "the host ID for the system VM", + "name": "hostid", + "type": "string" + }, + { + "description": "the ID of the system VM", + "name": "id", "type": "string" }, { @@ -19864,18 +20543,8 @@ "type": "integer" }, { - "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 template name for the system VM", - "name": "templatename", + "description": "the private netmask for the system VM", + "name": "privatenetmask", "type": "string" }, { @@ -19884,43 +20553,34 @@ "type": "date" }, { - "description": "the agent state of the system VM", - "name": "agentstate", + "description": "the link local IP address for the system vm", + "name": "linklocalip", "type": "string" }, + {}, { "description": "the gateway for the system VM", "name": "gateway", "type": "string" }, { - "description": "the Pod name for the system VM", - "name": "podname", - "type": "string" + "description": "the last disconnected date of host", + "name": "disconnected", + "type": "date" }, { - "description": "the private IP address for the system VM", - "name": "privateip", + "description": "guest vlan range", + "name": "guestvlan", "type": "string" }, { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", - "type": "boolean" - }, - { - "description": "public vlan range", - "name": "publicvlan", - "type": "list" - }, - { - "description": "the last disconnected date of host", - "name": "disconnected", - "type": "date" + "description": "the public netmask for the system VM", + "name": "publicnetmask", + "type": "string" }, { - "description": "the network domain for the system VM", - "name": "networkdomain", + "description": "the agent state of the system VM", + "name": "agentstate", "type": "string" }, { @@ -19929,26 +20589,21 @@ "type": "string" }, { - "description": "the host ID for the system VM", - "name": "hostid", + "description": "the system VM type", + "name": "systemvmtype", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the first DNS for the system VM", - "name": "dns1", + "description": "the name of the system VM", + "name": "name", "type": "string" }, - {}, { - "description": "the public MAC address for the system VM", - "name": "publicmacaddress", - "type": "string" - } + "description": "public vlan range", + "name": "publicvlan", + "type": "list" + }, + {} ] }, { @@ -19960,19 +20615,12 @@ "description": "the ID of the firewall rule", "length": 255, "name": "id", - "related": "createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules", + "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": "any text associated with the success or failure", "name": "displaytext", @@ -19983,6 +20631,13 @@ "name": "jobstatus", "type": "integer" }, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, + {}, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", @@ -19995,6 +20650,13 @@ "isasync": true, "name": "updateVPC", "params": [ + { + "description": "the display text of the VPC", + "length": 255, + "name": "displaytext", + "required": false, + "type": "string" + }, { "description": "the name of the VPC", "length": 255, @@ -20011,31 +20673,120 @@ "type": "uuid" }, { - "description": "an optional field, whether to the display the vpc to the end user or not", + "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", "length": 255, - "name": "fordisplay", + "name": "customid", "required": false, "since": "4.4", - "type": "boolean" - }, - { - "description": "the display text of the VPC", - "length": 255, - "name": "displaytext", - "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": "an optional field, whether to the display the vpc to the end user or not", "length": 255, - "name": "customid", + "name": "fordisplay", "required": false, "since": "4.4", - "type": "string" + "type": "boolean" } ], "related": "createVPC,listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", "response": [ + { + "description": "zone id of the vpc", + "name": "zoneid", + "type": "string" + }, + { + "description": "the project id of the VPC", + "name": "projectid", + "type": "string" + }, + { + "description": "the id of the VPC", + "name": "id", + "type": "string" + }, + { + "description": "the domain name of the owner", + "name": "domain", + "type": "string" + }, + { + "description": "the domain id of the VPC owner", + "name": "domainid", + "type": "string" + }, + { + "description": "vpc offering id the VPC is created from", + "name": "vpcofferingid", + "type": "string" + }, + { + "description": "true if VPC is region level", + "name": "regionlevelvpc", + "type": "boolean" + }, + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "The routes for the network to ease adding route in upstream router", + "name": "ip6routes", + "type": "set" + }, + { + "description": "an alternate display text of the VPC.", + "name": "displaytext", + "type": "string" + }, + { + "description": "the cidr the VPC", + "name": "cidr", + "type": "string" + }, + { + "description": "state of the VPC. Can be Inactive/Enabled", + "name": "state", + "type": "string" + }, + { + "description": "vpc offering name the VPC is created from", + "name": "vpcofferingname", + "type": "string" + }, + { + "description": "the project name of the VPC", + "name": "project", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the name of the zone the VPC belongs to", + "name": "zonename", + "type": "string" + }, + { + "description": "the date this VPC was created", + "name": "created", + "type": "date" + }, + { + "description": "the name of the VPC", + "name": "name", + "type": "string" + }, + { + "description": "is VPC uses distributed router for one hop forwarding and host based network ACL's", + "name": "distributedvpcrouter", + "type": "boolean" + }, { "description": "true if the entity/resource has annotations", "name": "hasannotations", @@ -20046,20 +20797,15 @@ "name": "account", "type": "string" }, - { - "description": "vpc offering name the VPC is created from", - "name": "vpcofferingname", - "type": "string" - }, - { - "description": "the name of the VPC", - "name": "name", - "type": "string" - }, { "description": "the list of supported services", "name": "service", "response": [ + { + "description": "the service name", + "name": "name", + "type": "string" + }, { "description": "the list of capabilities", "name": "capability", @@ -20082,33 +20828,33 @@ ], "type": "list" }, - { - "description": "the service name", - "name": "name", - "type": "string" - }, { "description": "the service provider name", "name": "provider", "response": [ - { - "description": "state of the network provider", - "name": "state", - "type": "string" - }, { "description": "true if individual services can be enabled/disabled", "name": "canenableindividualservice", "type": "boolean" }, + { + "description": "the destination physical network", + "name": "destinationphysicalnetworkid", + "type": "string" + }, + { + "description": "services for this provider", + "name": "servicelist", + "type": "list" + }, { "description": "the provider name", "name": "name", "type": "string" }, { - "description": "the destination physical network", - "name": "destinationphysicalnetworkid", + "description": "state of the network provider", + "name": "state", "type": "string" }, { @@ -20116,11 +20862,6 @@ "name": "id", "type": "string" }, - { - "description": "services for this provider", - "name": "servicelist", - "type": "list" - }, { "description": "the physical network this belongs to", "name": "physicalnetworkid", @@ -20132,135 +20873,23 @@ ], "type": "list" }, - { - "description": "is vpc for display to the regular user", - "name": "fordisplay", - "type": "boolean" - }, - { - "description": "the id of the VPC", - "name": "id", - "type": "string" - }, - { - "description": "the cidr the VPC", - "name": "cidr", - "type": "string" - }, - { - "description": "state of the VPC. Can be Inactive/Enabled", - "name": "state", - "type": "string" - }, - { - "description": "is VPC uses distributed router for one hop forwarding and host based network ACL's", - "name": "distributedvpcrouter", - "type": "boolean" - }, - { - "description": "true VPC requires restart", - "name": "restartrequired", - "type": "boolean" - }, - { - "description": "the project id of the VPC", - "name": "projectid", - "type": "string" - }, - { - "description": "the network domain of the VPC", - "name": "networkdomain", - "type": "string" - }, - { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the name of the zone the VPC belongs to", - "name": "zonename", - "type": "string" - }, - { - "description": "vpc offering id the VPC is created from", - "name": "vpcofferingid", - "type": "string" - }, - { - "description": "an alternate display text of the VPC.", - "name": "displaytext", - "type": "string" - }, - { - "description": "the domain name of the owner", - "name": "domain", - "type": "string" - }, - { - "description": "the project name of the VPC", - "name": "project", - "type": "string" - }, - { - "description": "the date this VPC was created", - "name": "created", - "type": "date" - }, - { - "description": "the list of networks belongign to the VPC", - "name": "network", - "type": "list" - }, - {}, - { - "description": "true if VPC is region level", - "name": "regionlevelvpc", - "type": "boolean" - }, - {}, - { - "description": "the domain id of the VPC owner", - "name": "domainid", - "type": "string" - }, - { - "description": "if this VPC has redundant router", - "name": "redundantvpcrouter", - "type": "boolean" - }, { "description": "the list of resource tags associated with the project", "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": "the project name where tag belongs to", - "name": "project", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { @@ -20269,13 +20898,13 @@ "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { @@ -20284,22 +20913,53 @@ "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", "type": "string" } ], "type": "list" }, { - "description": "zone id of the vpc", - "name": "zoneid", + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "true VPC requires restart", + "name": "restartrequired", + "type": "boolean" + }, + {}, + { + "description": "the list of networks belongign to the VPC", + "name": "network", + "type": "list" + }, + { + "description": "is vpc for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, + { + "description": "the network domain of the VPC", + "name": "networkdomain", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "if this VPC has redundant router", + "name": "redundantvpcrouter", + "type": "boolean" } ] }, @@ -20308,38 +20968,32 @@ "isasync": true, "name": "changeOutOfBandManagementPassword", "params": [ - { - "description": "the new host management interface password of maximum length 16, if none is provided a random password would be used", - "length": 255, - "name": "password", - "required": false, - "type": "string" - }, { "description": "the ID of the host", "length": 255, "name": "hostid", - "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost,addBaremetalHost,listExternalLoadBalancers", + "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost", "required": true, "type": "uuid" + }, + { + "description": "the new host management interface password of maximum length 16, if none is provided a random password would be used", + "length": 255, + "name": "password", + "required": false, + "type": "string" } ], "related": "enableOutOfBandManagementForHost,disableOutOfBandManagementForHost,enableOutOfBandManagementForCluster,disableOutOfBandManagementForCluster,enableOutOfBandManagementForZone,issueOutOfBandManagementPowerAction", "response": [ - { - "description": "the out-of-band management interface port", - "name": "port", - "type": "string" - }, { "description": "the operation result description", "name": "description", "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" }, { @@ -20348,29 +21002,35 @@ "type": "string" }, { - "description": "the operation result", - "name": "status", - "type": "boolean" + "description": "the out-of-band management interface powerState of the host", + "name": "powerstate", + "type": "powerstate" + }, + { + "description": "the out-of-band management interface username", + "name": "username", + "type": "string" }, {}, + {}, { - "description": "the out-of-band management interface address", - "name": "address", + "description": "the out-of-band management interface password", + "name": "password", "type": "string" }, { - "description": "the out-of-band management interface username", - "name": "username", + "description": "the out-of-band management driver for the host", + "name": "driver", "type": "string" }, { - "description": "the out-of-band management interface powerState of the host", - "name": "powerstate", - "type": "powerstate" + "description": "the out-of-band management interface address", + "name": "address", + "type": "string" }, { - "description": "the out-of-band management action (if issued)", - "name": "action", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -20379,9 +21039,9 @@ "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the operation result", + "name": "status", + "type": "boolean" }, { "description": "true if out-of-band management is enabled for the host", @@ -20389,8 +21049,8 @@ "type": "boolean" }, { - "description": "the out-of-band management interface password", - "name": "password", + "description": "the out-of-band management interface port", + "name": "port", "type": "string" } ], @@ -20402,16 +21062,9 @@ "name": "listResourceDetails", "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": "list resources by account. Must be used with the domainId parameter.", + "description": "list by key", "length": 255, - "name": "account", + "name": "key", "required": false, "type": "string" }, @@ -20424,28 +21077,19 @@ "type": "boolean" }, { - "description": "list only resources belonging to the domain specified", + "description": "", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "list by key", + "description": "list by resource id", "length": 255, - "name": "key", + "name": "resourceid", "required": false, "type": "string" }, - { - "description": "list objects by project", - "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", - "required": false, - "type": "uuid" - }, { "description": "list by resource type", "length": 255, @@ -20454,19 +21098,28 @@ "type": "string" }, { - "description": "list by resource id", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "resourceid", + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "List by keyword", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "keyword", + "name": "account", "required": false, "type": "string" }, + { + "description": "list only resources belonging to the domain specified", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", + "required": false, + "type": "uuid" + }, { "description": "list by key, value. Needs to be passed only along with key", "length": 255, @@ -20476,48 +21129,54 @@ "type": "string" }, { - "description": "", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "page", + "name": "isrecursive", "required": false, - "type": "integer" + "type": "boolean" + }, + { + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "length": 255, + "name": "listall", + "required": false, + "type": "boolean" }, { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "List by keyword", "length": 255, - "name": "isrecursive", + "name": "keyword", "required": false, - "type": "boolean" + "type": "string" } ], "related": "listTags", "response": [ { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the 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" }, { @@ -20525,9 +21184,10 @@ "name": "projectid", "type": "string" }, + {}, { - "description": "id of the resource", - "name": "resourceid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { @@ -20536,114 +21196,102 @@ "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "resource type", + "name": "resourcetype", "type": "string" }, + {}, { - "description": "tag value", - "name": "value", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {}, { - "description": "resource type", - "name": "resourcetype", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "id of the resource", + "name": "resourceid", "type": "string" } ], "since": "4.2" }, { - "description": "Dedicate an existing cluster", + "description": "Attempts to live patch systemVMs - CPVM, SSVM ", "isasync": true, - "name": "dedicateCluster", + "name": "patchSystemVm", "params": [ { - "description": "the name of the account which needs dedication. Must be used with domainId.", + "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": "account", + "name": "forced", "required": false, - "type": "string" - }, - { - "description": "the ID of the containing domain", - "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", - "required": true, - "type": "uuid" + "type": "boolean" }, { - "description": "the ID of the Cluster", + "description": "patches systemVM - CPVM/SSVM with the specified ID", "length": 255, - "name": "clusterid", - "related": "addCluster,updateCluster", - "required": true, + "name": "id", + "related": "listSystemVms,migrateSystemVm,startSystemVm,changeServiceForSystemVm", + "required": false, "type": "uuid" } ], - "related": "listDedicatedClusters", "response": [ - {}, - { - "description": "the ID of the cluster", - "name": "clusterid", - "type": "string" - }, - { - "description": "the Dedication Affinity Group ID of the cluster", - "name": "affinitygroupid", - "type": "string" - }, - { - "description": "the domain ID of the cluster", - "name": "domainid", - "type": "string" - }, { - "description": "the ID of the dedicated resource", - "name": "id", - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - { - "description": "the Account ID of the cluster", - "name": "accountid", - "type": "string" - }, {}, { - "description": "the name of the cluster", - "name": "clustername", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" } - ] + ], + "since": "4.17.0" }, { "description": "Creates a network offering.", "isasync": false, "name": "createNetworkOffering", "params": [ + { + "description": "the ID of the containing zone(s), null for public offerings", + "length": 255, + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": false, + "since": "4.13", + "type": "list" + }, + { + "description": "maximum number of concurrent connections supported by the network offering", + "length": 255, + "name": "maxconnections", + "required": false, + "type": "integer" + }, { "description": "the name of the network offering", "length": 255, @@ -20652,20 +21300,61 @@ "type": "string" }, { - "description": "set to true if the offering is to be enabled during creation. Default is false", + "description": "the display text of the network offering", + "length": 255, + "name": "displaytext", + "required": true, + "type": "string" + }, + { + "description": "data transfer rate in megabits per second allowed", + "length": 255, + "name": "networkrate", + "required": false, + "type": "integer" + }, + { + "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": "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": "services supported by the network offering", + "length": 255, + "name": "supportedservices", + "required": false, + "type": "list" + }, + { + "description": "the tags for the network offering.", + "length": 4096, + "name": "tags", + "required": false, + "type": "string" + }, + { + "description": "true if network offering supports vlans", "length": 255, - "name": "enable", + "name": "specifyvlan", "required": false, - "since": "4.16", "type": "boolean" }, { - "description": "Network offering details in key/value pairs. Supported keys are internallbprovider/publiclbprovider with service provider as a value, and promiscuousmode/macaddresschanges/forgedtransmits with true/false as value to accept/reject the security settings if available for a nic/portgroup", + "description": "true if network offering supports persistent networks; defaulted to false if not specified", "length": 255, - "name": "details", + "name": "ispersistent", "required": false, - "since": "4.2.0", - "type": "map" + "type": "boolean" }, { "description": "provider to service mapping. If not specified, the provider for the service will be mapped to the default provider on the physical network", @@ -20674,6 +21363,21 @@ "required": false, "type": "map" }, + { + "description": "the traffic type for the network offering. Supported type in current release is GUEST only", + "length": 255, + "name": "traffictype", + "required": true, + "type": "string" + }, + { + "description": "the ID of the containing domain(s), null for public offerings", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", + "required": false, + "type": "list" + }, { "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, @@ -20689,61 +21393,55 @@ "type": "string" }, { - "description": "true if network offering supports vlans", + "description": "true if network offering is meant to be used for VPC, false otherwise.", "length": 255, - "name": "specifyvlan", + "name": "forvpc", "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 ID of the containing domain(s), null for public offerings", + "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": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", + "name": "details", "required": false, - "type": "list" + "since": "4.2.0", + "type": "map" }, { - "description": "guest type of the network offering: Shared or Isolated", + "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": "guestiptype", - "required": true, + "name": "internetprotocol", + "required": false, + "since": "4.17.0", "type": "string" }, { - "description": "true if network offering supports persistent networks; defaulted to false if not specified", + "description": "true if the network offering is IP conserve mode enabled", "length": 255, - "name": "ispersistent", + "name": "conservemode", "required": false, "type": "boolean" }, { - "description": "true if guest network default egress policy is allow; false if default egress policy is deny", + "description": "true if network offering supports specifying ip ranges; defaulted to false if not specified", "length": 255, - "name": "egressdefaultpolicy", + "name": "specifyipranges", "required": false, "type": "boolean" }, { - "description": "desired service capabilities as part of network offering", + "description": "guest type of the network offering: Shared or Isolated", "length": 255, - "name": "servicecapabilitylist", - "required": false, - "type": "map" + "name": "guestiptype", + "required": true, + "type": "string" }, { - "description": "maximum number of concurrent connections supported by the network offering", + "description": "desired service capabilities as part of network offering", "length": 255, - "name": "maxconnections", + "name": "servicecapabilitylist", "required": false, - "type": "integer" + "type": "map" }, { "description": "the service offering ID used by virtual router provider", @@ -20752,76 +21450,144 @@ "related": "createServiceOffering,updateServiceOffering,listServiceOfferings", "required": false, "type": "uuid" + } + ], + "related": "listNetworkOfferings", + "response": [ + { + "description": "the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "domain", + "type": "string" }, { - "description": "the display text of the network offering", - "length": 255, - "name": "displaytext", - "required": true, + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "guest type of the network offering, can be Shared or Isolated", + "name": "guestiptype", "type": "string" }, { - "description": "data transfer rate in megabits per second allowed", - "length": 255, - "name": "networkrate", - "required": false, - "type": "integer" + "description": "true if network offering supports specifying ip ranges, false otherwise", + "name": "specifyipranges", + "type": "boolean" }, { - "description": "true if network offering is meant to be used for VPC, false otherwise.", - "length": 255, + "description": "the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "domainid", + "type": "string" + }, + { + "description": "additional key/value details tied with network offering", + "name": "details", + "type": "map" + }, + { + "description": "true if network offering can be used by VPC networks only", "name": "forvpc", - "required": false, "type": "boolean" }, { - "description": "true if network offering supports specifying ip ranges; defaulted to false if not specified", - "length": 255, - "name": "specifyipranges", - "required": false, - "type": "boolean" + "description": "the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "zone", + "type": "string" }, { - "description": "the tags for the network offering.", - "length": 4096, + "description": "the tags for the network offering", "name": "tags", - "required": false, "type": "string" }, { - "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": "the ID of the containing zone(s), null for public offerings", - "length": 255, + "description": "the name of the network offering", + "name": "name", + "type": "string" + }, + { + "description": "data transfer rate in megabits per second allowed.", + "name": "networkrate", + "type": "integer" + }, + { + "description": "the traffic type for the network offering, supported types are Public, Management, Control, Guest, Vlan or Storage.", + "name": "traffictype", + "type": "string" + }, + { + "description": "maximum number of concurrents connections to be handled by lb", + "name": "maxconnections", + "type": "integer" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the internet protocol of the network offering", + "name": "internetprotocol", + "type": "string" + }, + { + "description": "an alternate display text of the network offering.", + "name": "displaytext", + "type": "string" + }, + { + "description": "state of the network offering. Can be Disabled/Enabled/Inactive", + "name": "state", + "type": "string" + }, + {}, + { + "description": "availability of the network offering", + "name": "availability", + "type": "string" + }, + { + "description": "true if guest network default egress policy is allow; false if default egress policy is deny", + "name": "egressdefaultpolicy", + "type": "boolean" + }, + { + "description": "true if network offering is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": false, - "since": "4.13", - "type": "list" + "type": "string" }, { - "description": "true if the network offering is IP conserve mode enabled", - "length": 255, + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "true if network offering supports network that span multiple zones", + "name": "supportsstrechedl2subnet", + "type": "boolean" + }, + { + "description": "true if network offering is ip conserve mode enabled", "name": "conservemode", - "required": false, "type": "boolean" - } - ], - "related": "listNetworkOfferings", - "response": [ + }, { "description": "the id of the network offering", "name": "id", "type": "string" }, { - "description": "true if network offering is default, false otherwise", - "name": "isdefault", + "description": "true if network offering supports persistent networks, false otherwise", + "name": "ispersistent", "type": "boolean" }, { @@ -20832,16 +21598,16 @@ "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": "can this service capability value can be choosable while creatine network offerings", + "name": "canchooseservicecapability", + "type": "boolean" + }, { "description": "the capability value", "name": "value", @@ -20850,23 +21616,23 @@ ], "type": "list" }, + { + "description": "the service name", + "name": "name", + "type": "string" + }, { "description": "the service provider name", "name": "provider", "response": [ - { - "description": "true if individual services can be enabled/disabled", - "name": "canenableindividualservice", - "type": "boolean" - }, { "description": "the destination physical network", "name": "destinationphysicalnetworkid", "type": "string" }, { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", + "description": "the provider name", + "name": "name", "type": "string" }, { @@ -20875,8 +21641,8 @@ "type": "list" }, { - "description": "the provider name", - "name": "name", + "description": "state of the network provider", + "name": "state", "type": "string" }, { @@ -20885,105 +21651,96 @@ "type": "string" }, { - "description": "state of the network provider", - "name": "state", + "description": "the physical network this belongs to", + "name": "physicalnetworkid", "type": "string" + }, + { + "description": "true if individual services can be enabled/disabled", + "name": "canenableindividualservice", + "type": "boolean" } ], "type": "list" - }, - { - "description": "the service name", - "name": "name", - "type": "string" } ], "type": "list" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the tags for the network offering", - "name": "tags", + "description": "the ID of the service offering used by virtual router provider", + "name": "serviceofferingid", "type": "string" }, { - "description": "additional key/value details tied with network offering", - "name": "details", - "type": "map" - }, - { - "description": "true if network offering supports persistent networks, false otherwise", - "name": "ispersistent", + "description": "true if network offering supports vlans, false otherwise", + "name": "specifyvlan", "type": "boolean" }, + {}, { - "description": "maximum number of concurrents connections to be handled by lb", - "name": "maxconnections", - "type": "integer" - }, - { - "description": "true if network offering supports network that span multiple zones", - "name": "supportsstrechedl2subnet", + "description": "true if network offering supports public access for guest networks", + "name": "supportspublicaccess", "type": "boolean" - }, + } + ], + "since": "3.0.0" + }, + { + "description": "Dedicate an existing cluster", + "isasync": true, + "name": "dedicateCluster", + "params": [ { - "description": "true if network offering can be used by VPC networks only", - "name": "forvpc", - "type": "boolean" + "description": "the ID of the Cluster", + "length": 255, + "name": "clusterid", + "related": "addCluster,updateCluster", + "required": true, + "type": "uuid" }, { - "description": "the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zone", + "description": "the name of the account which needs dedication. Must be used with domainId.", + "length": 255, + "name": "account", + "required": false, "type": "string" }, - {}, { - "description": "guest type of the network offering, can be Shared or Isolated", - "name": "guestiptype", - "type": "string" - }, + "description": "the ID of the containing domain", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", + "required": true, + "type": "uuid" + } + ], + "related": "listDedicatedClusters", + "response": [ { - "description": "availability of the network offering", - "name": "availability", + "description": "the ID of the cluster", + "name": "clusterid", "type": "string" }, { - "description": "an alternate display text of the network offering.", - "name": "displaytext", + "description": "the ID of the dedicated resource", + "name": "id", "type": "string" }, + {}, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "true if guest network default egress policy is allow; false if default egress policy is deny", - "name": "egressdefaultpolicy", - "type": "boolean" - }, - { - "description": "true if network offering is ip conserve mode enabled", - "name": "conservemode", - "type": "boolean" - }, - { - "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zoneid", + "description": "the name of the cluster", + "name": "clustername", "type": "string" }, + {}, { - "description": "true if network offering supports public access for guest networks", - "name": "supportspublicaccess", - "type": "boolean" + "description": "the Dedication Affinity Group ID of the cluster", + "name": "affinitygroupid", + "type": "string" }, { - "description": "the traffic type for the network offering, supported types are Public, Management, Control, Guest, Vlan or Storage.", - "name": "traffictype", + "description": "the Account ID of the cluster", + "name": "accountid", "type": "string" }, { @@ -20992,66 +21749,22 @@ "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 date this network offering was created", - "name": "created", - "type": "date" - }, - { - "description": "state of the network offering. Can be Disabled/Enabled/Inactive", - "name": "state", - "type": "string" - }, - { - "description": "true if network offering supports specifying ip ranges, false otherwise", - "name": "specifyipranges", - "type": "boolean" - }, - { - "description": "true if network offering supports vlans, false otherwise", - "name": "specifyvlan", - "type": "boolean" - }, - { - "description": "data transfer rate in megabits per second allowed.", - "name": "networkrate", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": "the name of the network offering", - "name": "name", - "type": "string" - }, - { - "description": "the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "description": "the domain ID of the cluster", "name": "domainid", "type": "string" - }, - { - "description": "the ID of the service offering used by virtual router provider", - "name": "serviceofferingid", - "type": "string" - }, - {} - ], - "since": "3.0.0" + } + ] }, { "description": "Creates an IP forwarding rule", "isasync": true, "name": "createIpForwardingRule", "params": [ - { - "description": "the CIDR list to forward traffic from. Multiple entries must be separated by a single comma character (,). This parameter is deprecated. Do not use.", - "length": 255, - "name": "cidrlist", - "required": false, - "type": "list" - }, { "description": "the start port for the rule", "length": 255, @@ -21060,18 +21773,11 @@ "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", + "description": "the end port for the rule", "length": 255, - "name": "openfirewall", + "name": "endport", "required": false, - "type": "boolean" - }, - { - "description": "the protocol for the rule. Valid values are TCP or UDP.", - "length": 255, - "name": "protocol", - "required": true, - "type": "string" + "type": "integer" }, { "description": "the public IP address ID of the forwarding rule, already associated via associateIp", @@ -21082,90 +21788,119 @@ "type": "uuid" }, { - "description": "the end port for the rule", + "description": "the CIDR list to forward traffic from. Multiple entries must be separated by a single comma character (,). This parameter is deprecated. Do not use.", "length": 255, - "name": "endport", + "name": "cidrlist", "required": false, - "type": "integer" + "type": "list" + }, + { + "description": "the protocol for the rule. Valid values are TCP or UDP.", + "length": 255, + "name": "protocol", + "required": true, + "type": "string" + }, + { + "description": "if true, firewall rule for source/end public port is automatically created; if false - firewall rule has to be created explicitly. Has value true by default", + "length": 255, + "name": "openfirewall", + "required": false, + "type": "boolean" } ], - "related": "createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,listIpForwardingRules", + "related": "createIpv6FirewallRule,updateIpv6FirewallRule,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,listIpForwardingRules", "response": [ + { + "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", + "type": "string" + }, + { + "description": "the ending port of port forwarding rule's private port range", + "name": "privateendport", + "type": "string" + }, + { + "description": "is firewall for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, + { + "description": "the 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", + "type": "string" + }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "tag value", - "name": "value", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the project name where tag belongs to", + "name": "project", "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": "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": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" } ], "type": "list" }, { - "description": "the 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 cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", + "description": "the starting port of port forwarding rule's public port range", + "name": "publicport", "type": "string" }, { - "description": "the vm ip address for the port forwarding rule", - "name": "vmguestip", + "description": "the id of the guest network the port forwarding rule belongs to", + "name": "networkid", "type": "string" }, { @@ -21173,42 +21908,20 @@ "name": "state", "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 ending port of port forwarding rule's private port range", "name": "publicendport", "type": "string" }, { - "description": "the ID of the port forwarding rule", - "name": "id", - "type": "string" - }, - {}, - { - "description": "is firewall for display to the regular user", - "name": "fordisplay", - "type": "boolean" - }, - { - "description": "the public ip address id for the port forwarding rule", - "name": "ipaddressid", + "description": "the VM display name for the port forwarding rule", + "name": "virtualmachinedisplayname", "type": "string" }, { - "description": "the UUID of the latest async job acting on 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 VM name for the port forwarding rule", @@ -21221,18 +21934,25 @@ "type": "string" }, { - "description": "the starting port of port forwarding rule's public port range", - "name": "publicport", + "description": "the ID of the port forwarding rule", + "name": "id", "type": "string" }, + {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the starting port of port forwarding rule's private port range", + "name": "privateport", + "type": "string" + }, + {}, + { + "description": "the 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": "the VM ID for the port forwarding rule", + "name": "virtualmachineid", "type": "string" }, { @@ -21248,18 +21968,10 @@ "name": "listVolumesMetrics", "params": [ { - "description": "the pod id the disk volume belongs to", - "length": 255, - "name": "podid", - "related": "listPods,updatePod,createManagementNetworkIpRange", - "required": false, - "type": "uuid" - }, - { - "description": "the ID of the disk volume", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "id", - "related": "attachVolume,createVolume,updateVolume,detachVolume,listVolumes,migrateVolume,resizeVolume,destroyVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", "required": false, "type": "uuid" }, @@ -21267,45 +21979,45 @@ "description": "the IDs of the volumes, mutually exclusive with id", "length": 255, "name": "ids", - "related": "attachVolume,createVolume,updateVolume,detachVolume,listVolumes,migrateVolume,resizeVolume,destroyVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", + "related": "attachVolume,createVolume,updateVolume,detachVolume,listVolumes,migrateVolume,resizeVolume,destroyVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", "required": false, "since": "4.9", "type": "list" }, { - "description": "state of the volume. Possible values are: Ready, Allocated, Destroy, Expunging, Expunged.", + "description": "", "length": 255, - "name": "state", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { - "description": "list volumes on specified host", + "description": "the ID of the disk volume", "length": 255, - "name": "hostid", - "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost,addBaremetalHost,listExternalLoadBalancers", + "name": "id", + "related": "attachVolume,createVolume,updateVolume,detachVolume,listVolumes,migrateVolume,resizeVolume,destroyVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", "required": false, "type": "uuid" }, { - "description": "the cluster id the disk volume belongs to", + "description": "", "length": 255, - "name": "clusterid", - "related": "addCluster,updateCluster", + "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": "the pod id the disk volume belongs to", "length": 255, - "name": "isrecursive", + "name": "podid", + "related": "listPods,updatePod,createManagementNetworkIpRange", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "the name of the disk volume", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "name", + "name": "account", "required": false, "type": "string" }, @@ -21317,19 +22029,20 @@ "type": "string" }, { - "description": "", + "description": "list volumes on specified host", "length": 255, - "name": "pagesize", + "name": "hostid", + "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "the ID of the virtual machine", + "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", "length": 255, - "name": "virtualmachineid", - "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,revertToVMSnapshot,updateVmNicIp,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance", + "name": "displayvolume", "required": false, - "type": "uuid" + "since": "4.4", + "type": "boolean" }, { "description": "the ID of the storage pool, available to ROOT admin only", @@ -21341,48 +22054,58 @@ "type": "string" }, { - "description": "List by keyword", + "description": "list volumes by disk offering", "length": 255, - "name": "keyword", + "name": "diskofferingid", + "related": "createDiskOffering,updateDiskOffering,listDiskOfferings", "required": false, - "type": "string" + "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", + "description": "the cluster id the disk volume belongs to", "length": 255, - "name": "listall", + "name": "clusterid", + "related": "addCluster,updateCluster", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "list objects by project", + "description": "the name of the disk volume", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "name": "name", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "page", + "name": "listall", "required": false, - "type": "integer" + "type": "boolean" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "the ID of the availability zone", "length": 255, - "name": "account", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "description": "List resources by tags (key/value pairs)", "length": 255, - "name": "displayvolume", + "name": "tags", "required": false, - "since": "4.4", - "type": "boolean" + "type": "map" + }, + { + "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,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,revertToVMSnapshot,updateVmNicIp,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance", + "required": false, + "type": "uuid" }, { "description": "list only resources belonging to the domain specified", @@ -21393,41 +22116,33 @@ "type": "uuid" }, { - "description": "the ID of the availability zone", + "description": "List by keyword", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "list volumes by disk offering", + "description": "state of the volume. Possible values are: Ready, Allocated, Destroy, Expunging, Expunged.", "length": 255, - "name": "diskofferingid", - "related": "createDiskOffering,updateDiskOffering,listDiskOfferings", + "name": "state", "required": false, - "since": "4.4", - "type": "uuid" + "type": "string" }, { - "description": "List resources by tags (key/value pairs)", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "tags", + "name": "isrecursive", "required": false, - "type": "map" + "type": "boolean" } ], "related": "", "response": [ { - "description": "Hypervisor the volume belongs to", - "name": "hypervisor", - "type": "string" - }, - { - "description": "bytes write rate of the disk volume", - "name": "diskBytesWriteRate", - "type": "long" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { "description": "id of the virtual machine", @@ -21435,100 +22150,43 @@ "type": "string" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", - "type": "string" + "description": "the date the disk volume was created", + "name": "created", + "type": "date" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "name of the disk volume", + "name": "name", "type": "string" }, { - "description": "the write (bytes) of disk on the vm", - "name": "diskkbswrite", - "type": "long" + "description": "the boolean state of whether the volume is destroyed or not", + "name": "destroyed", + "type": "boolean" }, { - "description": "the chain info of the volume", - "name": "chaininfo", + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", "type": "string" }, { - "description": "the display text of the service offering for root disk", - "name": "serviceofferingdisplaytext", - "type": "string" + "description": "the write (IO) of disk on the vm", + "name": "diskiowrite", + "type": "long" }, { - "description": "name of the availability zone", - "name": "zonename", + "description": "name of the primary storage hosting the disk volume", + "name": "storage", "type": "string" }, { - "description": "the list of resource tags associated", - "name": "tags", - "response": [ - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "cluster name where the volume is allocated", - "name": "clustername", - "type": "string" + "description": "size of the disk volume", + "name": "size", + "type": "long" }, { - "description": "name of the disk offering", - "name": "diskofferingname", + "description": "shared or local storage", + "name": "storagetype", "type": "string" }, { @@ -21537,93 +22195,83 @@ "type": "integer" }, { - "description": "the date the disk volume was created", - "name": "created", - "type": "date" + "description": "the status of the volume", + "name": "status", + "type": "string" }, { - "description": "id of the primary storage hosting the disk volume; returned to admin user only", - "name": "storageid", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "the total disk iops", - "name": "diskiopstotal", - "type": "long" + "description": "the project id of the vpn", + "name": "projectid", + "type": "string" }, { - "description": "shared or local storage", - "name": "storagetype", + "description": "the display text of the service offering for root disk", + "name": "serviceofferingdisplaytext", "type": "string" }, { - "description": "the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached.", - "name": "deviceid", + "description": "the bytes allocated", + "name": "physicalsize", "type": "long" }, { - "description": "the boolean state of whether the volume is destroyed or not", - "name": "destroyed", + "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": "true if the volume is extractable, false otherwise", + "name": "isextractable", + "type": "boolean" }, { "description": "state of the virtual machine", "name": "vmstate", "type": "string" }, - { - "description": "name of the disk volume", - "name": "name", - "type": "string" - }, - { - "description": "max iops of the disk volume", - "name": "maxiops", - "type": "long" - }, { "description": "min iops of the disk volume", "name": "miniops", "type": "long" }, { - "description": "the write (io) of disk on the vm", - "name": "diskiowrite", + "description": "bytes write rate of the disk volume", + "name": "diskBytesWriteRate", "type": "long" }, { - "description": "the bytes actually consumed on disk", - "name": "virtualsize", + "description": "bytes read rate of the disk volume", + "name": "diskBytesReadRate", "type": "long" }, { - "description": "an optional field whether to the display the volume to the end user or not.", - "name": "displayvolume", - "type": "boolean" + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", + "type": "string" }, { - "description": "pod id of the volume", - "name": "podid", + "description": "cluster name where the volume is allocated", + "name": "clustername", "type": "string" }, { - "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 path of the volume", - "name": "path", - "type": "string" + "description": "the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached.", + "name": "deviceid", + "type": "long" }, { - "description": "display name of the virtual machine", - "name": "vmdisplayname", + "description": "disk size in GiB", + "name": "sizegb", "type": "string" }, { @@ -21632,135 +22280,149 @@ "type": "string" }, { - "description": "the read (bytes) of disk on the vm", - "name": "diskkbsread", - "type": "long" + "description": "the name of the template for the virtual machine", + "name": "templatename", + "type": "string" }, { - "description": "the status of the volume", - "name": "status", + "description": "the date the volume was attached to a VM instance", + "name": "attached", + "type": "date" + }, + { + "description": "pod id of the volume", + "name": "podid", "type": "string" }, { - "description": "true if storage snapshot is supported for the volume, false otherwise", - "name": "supportsstoragesnapshot", - "type": "boolean" + "description": "the display text of the disk offering", + "name": "diskofferingdisplaytext", + "type": "string" }, + {}, { - "description": "cluster id of the volume", - "name": "clusterid", + "description": "display name of the virtual machine", + "name": "vmdisplayname", "type": "string" }, { - "description": "the domain associated with the disk volume", - "name": "domain", + "description": "ID of the snapshot from which this volume was created", + "name": "snapshotid", "type": "string" }, { - "description": "the date the volume was attached to a VM instance", - "name": "attached", - "type": "date" + "description": "the path of the volume", + "name": "path", + "type": "string" }, { - "description": "the account associated with the disk volume", - "name": "account", + "description": "cluster id of the volume", + "name": "clusterid", "type": "string" }, - {}, + { + "description": "the read (IO) of disk on the vm", + "name": "diskioread", + "type": "long" + }, { "description": "the name of the ISO attached to the virtual machine", "name": "isoname", "type": "string" }, - {}, { - "description": "the ID of the domain associated with the disk volume", - "name": "domainid", + "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": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the bytes allocated", - "name": "physicalsize", + "description": "IO requests write rate of the disk volume per the disk offering", + "name": "diskIopsWriteRate", "type": "long" }, + { + "description": "the disk utilization", + "name": "utilization", + "type": "string" + }, + { + "description": "id of the primary storage hosting the disk volume; returned to admin user only", + "name": "storageid", + "type": "string" + }, { "description": "the project name of the vpn", "name": "project", "type": "string" }, { - "description": "need quiesce vm or not when taking snapshot", - "name": "quiescevm", - "type": "boolean" + "description": "IO requests read rate of the disk volume per the disk offering", + "name": "diskIopsReadRate", + "type": "long" }, { - "description": "ID of the service offering for root disk", - "name": "serviceofferingid", + "description": "provisioning type used to create volumes.", + "name": "provisioningtype", "type": "string" }, { - "description": "type of the disk volume (ROOT or DATADISK)", - "name": "type", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { - "description": "pod name of the volume", - "name": "podname", + "description": "the account associated with the disk volume", + "name": "account", "type": "string" }, { - "description": "true if the volume is extractable, false otherwise", - "name": "isextractable", + "description": "an optional field whether to the display the volume to the end user or not.", + "name": "displayvolume", "type": "boolean" }, { - "description": "the disk utilization", - "name": "utilization", - "type": "string" - }, - { - "description": "disk size in GiB", - "name": "sizegb", - "type": "string" + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" }, { - "description": "ID of the disk volume", - "name": "id", + "description": "the ID of the domain associated with the disk volume", + "name": "domainid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "type of the disk volume (ROOT or DATADISK)", + "name": "type", "type": "string" }, { - "description": "io requests write rate of the disk volume per the disk offering", - "name": "diskIopsWriteRate", + "description": "the total disk iops", + "name": "diskiopstotal", "type": "long" }, { - "description": "ID of the snapshot from which this volume was created", - "name": "snapshotid", - "type": "string" + "description": "the bytes actually consumed on disk", + "name": "virtualsize", + "type": "long" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "the chain info of the volume", + "name": "chaininfo", "type": "string" }, { - "description": "the display text of the disk offering", - "name": "diskofferingdisplaytext", - "type": "string" + "description": "max iops of the disk volume", + "name": "maxiops", + "type": "long" }, { - "description": "ID of the disk offering", - "name": "diskofferingid", + "description": "the state of the disk volume", + "name": "state", "type": "string" }, { @@ -21769,49 +22431,112 @@ "type": "string" }, { - "description": "io requests read rate of the disk volume per the disk offering", - "name": "diskIopsReadRate", + "description": "name of the availability zone", + "name": "zonename", + "type": "string" + }, + { + "description": "the VM's disk read in KiB", + "name": "diskkbsread", "type": "long" }, + {}, { - "description": "name of the service offering for root disk", - "name": "serviceofferingname", + "description": "ID of the disk volume", + "name": "id", "type": "string" }, { - "description": "name of the primary storage hosting the disk volume", - "name": "storage", + "description": "name of the disk offering", + "name": "diskofferingname", "type": "string" }, { - "description": "size of the disk volume", - "name": "size", - "type": "long" + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the 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" + } + ], + "type": "set" }, { - "description": "the project id of the vpn", - "name": "projectid", + "description": "name of the service offering for root disk", + "name": "serviceofferingname", "type": "string" }, { - "description": "provisioning type used to create volumes.", - "name": "provisioningtype", + "description": "Hypervisor the volume belongs to", + "name": "hypervisor", "type": "string" }, { - "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 state of the disk volume", - "name": "state", + "description": "the domain associated with the disk volume", + "name": "domain", "type": "string" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "ID of the disk offering", + "name": "diskofferingid", "type": "string" + }, + { + "description": "true if storage snapshot is supported for the volume, false otherwise", + "name": "supportsstoragesnapshot", + "type": "boolean" } ], "since": "4.9.3" @@ -21832,45 +22557,45 @@ "related": "listElastistorVolume", "response": [ { - "description": "graceallowed", - "name": "graceallowed", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, { - "description": "compression", - "name": "compression", + "description": "the id of the volume", + "name": "id", "type": "string" }, - {}, { "description": "the name of the volume", "name": "name", "type": "string" }, { - "description": "the id of the volume", - "name": "id", + "description": "syncronization", + "name": "sync", "type": "string" }, { - "description": "deduplication", - "name": "deduplication", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "compression", + "name": "compression", + "type": "string" }, + {}, { - "description": "syncronization", - "name": "sync", + "description": "graceallowed", + "name": "graceallowed", "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "deduplication", + "name": "deduplication", "type": "string" } ] @@ -21881,26 +22606,27 @@ "name": "listDetailOptions", "params": [ { - "description": "the resource type such as UserVm, Template etc.", + "description": "the UUID of the resource (optional)", "length": 255, - "name": "resourcetype", - "required": true, + "name": "resourceid", + "required": false, "type": "string" }, { - "description": "the UUID of the resource (optional)", + "description": "the resource type such as UserVm, Template etc.", "length": 255, - "name": "resourceid", - "required": false, + "name": "resourcetype", + "required": true, "type": "string" } ], "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" }, {}, { @@ -21908,11 +22634,10 @@ "name": "details", "type": "map" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" } ], "since": "4.13" @@ -21923,34 +22648,34 @@ "name": "listSslCerts", "params": [ { - "description": "Project that owns the SSL certificate", + "description": "Load balancer rule ID", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "name": "lbruleid", + "related": "createIpv6FirewallRule,updateIpv6FirewallRule,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,listIpForwardingRules", "required": false, "type": "uuid" }, { - "description": "Account ID", + "description": "ID of SSL certificate", "length": 255, - "name": "accountid", - "related": "createAccount,disableAccount,enableAccount,updateAccount,markDefaultZoneForAccount,listAccounts,listAccounts", + "name": "certid", + "related": "uploadSslCert,listSslCerts", "required": false, "type": "uuid" }, { - "description": "ID of SSL certificate", + "description": "Project that owns the SSL certificate", "length": 255, - "name": "certid", - "related": "uploadSslCert,listSslCerts", + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", "required": false, "type": "uuid" }, { - "description": "Load balancer rule ID", + "description": "Account ID", "length": 255, - "name": "lbruleid", - "related": "createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,listIpForwardingRules", + "name": "accountid", + "related": "createAccount,disableAccount,enableAccount,updateAccount,markDefaultZoneForAccount,listAccounts,listAccounts", "required": false, "type": "uuid" } @@ -21958,49 +22683,50 @@ "related": "uploadSslCert", "response": [ { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the project name of the certificate", - "name": "project", + "description": "name", + "name": "name", "type": "string" }, { - "description": "certificate fingerprint", - "name": "fingerprint", - "type": "string" + "description": "List of loabalancers this certificate is bound to", + "name": "loadbalancerrulelist", + "type": "list" }, { - "description": "the domain name of the network owner", - "name": "domain", + "description": "SSL certificate ID", + "name": "id", "type": "string" }, - {}, { "description": "the project id of the certificate", "name": "projectid", "type": "string" }, { - "description": "name", - "name": "name", + "description": "the domain id of the network owner", + "name": "domainid", "type": "string" }, { - "description": "certificate chain", - "name": "certchain", + "description": "certificate fingerprint", + "name": "fingerprint", "type": "string" }, + {}, + {}, { - "description": "account for the certificate", - "name": "account", + "description": "certificate", + "name": "certificate", "type": "string" }, { - "description": "certificate", - "name": "certificate", + "description": "the domain name of the network owner", + "name": "domain", + "type": "string" + }, + { + "description": "account for the certificate", + "name": "account", "type": "string" }, { @@ -22008,21 +22734,20 @@ "name": "jobid", "type": "string" }, - {}, { - "description": "the domain id of the network owner", - "name": "domainid", + "description": "certificate chain", + "name": "certchain", "type": "string" }, { - "description": "List of loabalancers this certificate is bound to", - "name": "loadbalancerrulelist", - "type": "list" + "description": "the project name of the certificate", + "name": "project", + "type": "string" }, { - "description": "SSL certificate ID", - "name": "id", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ] }, @@ -22032,20 +22757,34 @@ "name": "listPrivateGateways", "params": [ { - "description": "list gateways by ip address", + "description": "list gateways by vlan", "length": 255, - "name": "ipaddress", + "name": "vlan", "required": false, "type": "string" }, { - "description": "list gateways by vpc", + "description": "list gateways by state", "length": 255, - "name": "vpcid", - "related": "createVPC,listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", + "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 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, @@ -22055,26 +22794,25 @@ "type": "uuid" }, { - "description": "list gateways by vlan", + "description": "list gateways by ip address", "length": 255, - "name": "vlan", + "name": "ipaddress", "required": false, "type": "string" }, { - "description": "list private gateway by id", + "description": "", "length": 255, - "name": "id", - "related": "createPrivateGateway,listPrivateGateways", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "list gateways by state", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "state", + "name": "isrecursive", "required": false, - "type": "string" + "type": "boolean" }, { "description": "", @@ -22084,12 +22822,20 @@ "type": "integer" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "isrecursive", + "name": "listall", "required": false, "type": "boolean" }, + { + "description": "list gateways by vpc", + "length": 255, + "name": "vpcid", + "related": "createVPC,listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", + "required": false, + "type": "uuid" + }, { "description": "List by keyword", "length": 255, @@ -22098,246 +22844,499 @@ "type": "string" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "list private gateway by id", "length": 255, - "name": "account", + "name": "id", + "related": "createPrivateGateway,listPrivateGateways,createPrivateGateway", "required": false, + "type": "uuid" + } + ], + "related": "createPrivateGateway,createPrivateGateway", + "response": [ + { + "description": "the project name of the private gateway", + "name": "project", "type": "string" }, { - "description": "list objects by project", - "length": 255, + "description": "Souce Nat enable status", + "name": "sourcenatsupported", + "type": "boolean" + }, + { + "description": "VPC id the private gateway belongs to", + "name": "vpcid", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the private gateway's netmask", + "name": "netmask", + "type": "string" + }, + { + "description": "the domain associated with the private gateway", + "name": "domain", + "type": "string" + }, + { + "description": "the name of the Network associated with this private gateway", + "name": "associatednetwork", + "type": "string" + }, + { + "description": "zone id of the private gateway", + "name": "zoneid", + "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": "State of the gateway, can be Creating, Ready, Deleting", + "name": "state", + "type": "string" + }, + { + "description": "the ID of the domain associated with the private gateway", + "name": "domainid", + "type": "string" + }, + { + "description": "the network implementation uri for the private gateway", + "name": "vlan", + "type": "string" + }, + { + "description": "the gateway", + "name": "gateway", + "type": "string" + }, + { + "description": "ACL Id set for private gateway", + "name": "aclid", + "type": "string" + }, + {}, + {}, + { + "description": "VPC name the private gateway belongs to", + "name": "vpcname", + "type": "string" + }, + { + "description": "the id of the private gateway", + "name": "id", + "type": "string" + }, + { + "description": "the project id of the private gateway", "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", - "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", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the account associated with the private gateway", + "name": "account", + "type": "string" + }, + { + "description": "the private gateway's ip address", + "name": "ipaddress", + "type": "string" + }, + { + "description": "the name of the zone the private gateway belongs to", + "name": "zonename", + "type": "string" + }, + { + "description": "ACL name set for private gateway", + "name": "aclname", + "type": "string" + }, + { + "description": "the physical network id", + "name": "physicalnetworkid", + "type": "string" + } + ] + }, + { + "description": "Update the default Ip of a VM Nic", + "isasync": true, + "name": "updateVmNicIp", + "params": [ + { + "description": "Secondary IP Address", "length": 255, - "name": "listall", + "name": "ipaddress", "required": false, + "type": "string" + }, + { + "description": "the ID of the nic to which you want to assign private IP", + "length": 255, + "name": "nicid", + "related": "listNics", + "required": true, + "type": "uuid" + } + ], + "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance", + "response": [ + { + "description": "the group name of the virtual machine", + "name": "group", + "type": "string" + }, + { + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" + }, + { + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" + }, + { + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", + "type": "string" + }, + { + "description": "the user's name who deployed the virtual machine", + "name": "username", + "type": "string" + }, + { + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" + }, + { + "description": "OS name of the vm", + "name": "osdisplayname", + "type": "string" + }, + {}, + { + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", + "type": "string" + }, + { + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", "type": "boolean" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - } - ], - "related": "createPrivateGateway", - "response": [ + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", + "type": "string" + }, + { + "description": "the name of the host for the virtual machine", + "name": "hostname", + "type": "string" + }, + { + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", + "type": "string" + }, + { + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" + }, + { + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" + }, { - "description": "VPC id the private gateway belongs to", - "name": "vpcid", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, { - "description": "the id of the private gateway", - "name": "id", + "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": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", "type": "string" }, { - "description": "the private gateway's netmask", - "name": "netmask", - "type": "string" + "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", + "type": "long" }, - {}, { - "description": "State of the gateway, can be Creating, Ready, Deleting", - "name": "state", + "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", + "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": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the memory allocated for the virtual machine", + "name": "memory", "type": "integer" }, { - "description": "the ID of the domain associated with the private gateway", - "name": "domainid", + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", "type": "string" }, { - "description": "the project id of the private gateway", - "name": "projectid", + "description": "the group ID of the virtual machine", + "name": "groupid", "type": "string" }, { - "description": "the project name of the private gateway", - "name": "project", + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", "type": "string" }, { - "description": "the name of the zone the private gateway belongs to", + "description": "the name of the availability zone for the virtual machine", "name": "zonename", "type": "string" }, { - "description": "the physical network id", - "name": "physicalnetworkid", + "description": "Guest vm Boot Mode", + "name": "bootmode", "type": "string" }, { - "description": "the gateway", - "name": "gateway", + "description": "the password (if exists) of the virtual machine", + "name": "password", "type": "string" }, { - "description": "ACL name set for private gateway", - "name": "aclname", + "description": "the memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" + }, + { + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", "type": "string" }, { - "description": "the account associated with the private gateway", - "name": "account", + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", + "type": "boolean" + }, + { + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" + }, + { + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, - {}, { - "description": "the domain associated with the private gateway", - "name": "domain", + "description": "the ID of the host for the virtual machine", + "name": "hostid", "type": "string" }, { - "description": "the private gateway's ip address", - "name": "ipaddress", + "description": "Os type ID of the virtual machine", + "name": "guestosid", "type": "string" }, { - "description": "zone id of the private gateway", - "name": "zoneid", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, + {}, { - "description": "Souce Nat enable status", - "name": "sourcenatsupported", - "type": "boolean" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "VPC name the private gateway belongs to", - "name": "vpcname", + "description": "the name of the disk offering of the virtual machine", + "name": "diskofferingname", "type": "string" }, { - "description": "ACL Id set for private gateway", - "name": "aclid", + "description": "the ID of the virtual machine", + "name": "id", "type": "string" }, { - "description": "the network implementation uri for the private gateway", - "name": "vlan", + "description": "the state of the virtual machine", + "name": "state", "type": "string" - } - ] - }, - { - "description": "Update the default Ip of a VM Nic", - "isasync": true, - "name": "updateVmNicIp", - "params": [ - { - "description": "the ID of the nic to which you want to assign private IP", - "length": 255, - "name": "nicid", - "related": "listNics", - "required": true, - "type": "uuid" }, { - "description": "Secondary IP Address", - "length": 255, - "name": "ipaddress", - "required": false, + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", "type": "string" - } - ], - "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance", - "response": [ + }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "OS type id of the vm", + "name": "ostypeid", "type": "string" }, { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", + "description": "device type of the root volume", + "name": "rootdevicetype", "type": "string" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" + }, + { + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the pool type of the virtual machine", - "name": "pooltype", + "description": "the ID of the availablility zone for the virtual machine", + "name": "zoneid", "type": "string" }, { - "description": "the name of the disk offering of the virtual machine", - "name": "diskofferingname", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, + { + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" + }, { "description": "the list of nics associated with vm", "name": "nic", "response": [ { - "description": "the type of the nic", - "name": "type", - "type": "string" - }, - { - "description": "the IPv6 address of network", - "name": "ip6address", + "description": "the ID of the nic", + "name": "id", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the gateway of the nic", + "name": "gateway", "type": "string" }, { - "description": "the netmask of the nic", - "name": "netmask", + "description": "the ip address of the nic", + "name": "ipaddress", "type": "string" }, { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", - "type": "string" + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" }, { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" }, { - "description": "the gateway of the nic", - "name": "gateway", + "description": "the isolation uri of the nic", + "name": "isolationuri", "type": "string" }, { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" - }, - { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", "type": "string" }, { @@ -22345,39 +23344,49 @@ "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": "name of the vpc to which the nic belongs", + "name": "vpcname", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", + "type": "string" + }, { "description": "the ID of the corresponding network", "name": "networkid", "type": "string" }, { - "description": "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": "the name of the corresponding network", - "name": "networkname", + "description": "the netmask of the nic", + "name": "netmask", "type": "string" }, { - "description": "the ip address of the nic", - "name": "ipaddress", + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "the traffic type of the nic", + "name": "traffictype", + "type": "string" + }, + { + "description": "the name of the corresponding network", + "name": "networkname", "type": "string" }, { @@ -22386,44 +23395,54 @@ "type": "string" }, { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "type": "string" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "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 ID of the nic", - "name": "id", + "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": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" } ], "type": "set" @@ -22433,286 +23452,260 @@ "name": "publicip", "type": "string" }, - {}, { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", - "type": "string" + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" }, { - "description": "the account associated with the virtual machine", - "name": "account", + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", "type": "string" }, - {}, - { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" - }, { - "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": "the user's ID who deployed the virtual machine", - "name": "userid", + "description": "Guest vm Boot Type", + "name": "boottype", "type": "string" }, - { - "description": "the target memory in vm", - "name": "memorytargetkbs", - "type": "long" - }, - { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" - }, + {}, { "description": "the ID of the ISO attached to the virtual machine", "name": "isoid", "type": "string" }, { - "description": "the internal memory that's free in vm or zero if it can not be calculated", - "name": "memoryintfreekbs", - "type": "long" + "description": "the ID of the disk offering of the virtual machine", + "name": "diskofferingid", + "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", + "description": "the user's ID who deployed the virtual machine", + "name": "userid", "type": "string" }, { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "OS name of the vm", - "name": "osdisplayname", + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", "type": "string" }, { - "description": "the user's name who deployed the virtual machine", - "name": "username", + "description": "the name of the virtual machine", + "name": "name", "type": "string" }, { - "description": "the ID of the disk offering of the virtual machine", - "name": "diskofferingid", - "type": "string" + "description": "the read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" }, { "description": "list of security groups associated with the virtual machine", "name": "securitygroup", "response": [ { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" - }, - { - "description": "the 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 ingress rules associated with the security group", - "name": "ingressrule", + "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": "security group name", - "name": "securitygroupname", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the project 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": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - } - ], - "type": "set" + "description": "id of the resource", + "name": "resourceid", + "type": "string" }, { - "description": "the id of the security group rule", - "name": "ruleid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" }, { - "description": "account owning the security group rule", - "name": "account", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the protocol of the security group rule", - "name": "protocol", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" }, { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" } ], "type": "set" }, { - "description": "the account owning the security group", - "name": "account", + "description": "the description of the security group", + "name": "description", "type": "string" }, { - "description": "the domain name of the security group", - "name": "domain", + "description": "the domain ID of the security group", + "name": "domainid", "type": "string" }, { - "description": "the project id of the group", - "name": "projectid", + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" + }, + { + "description": "the ID of the security group", + "name": "id", "type": "string" }, { - "description": "the list of resource tags associated with the rule", - "name": "tags", + "description": "the list of ingress rules associated with the security group", + "name": "ingressrule", "response": [ { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the id of the security group rule", + "name": "ruleid", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "security group name", + "name": "securitygroupname", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "account owning the security group rule", + "name": "account", "type": "string" }, { - "description": "tag value", - "name": "value", - "type": "string" + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" }, { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" }, { - "description": "tag key name", - "name": "key", - "type": "string" + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "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 code for the ICMP message response", + "name": "icmpcode", + "type": "integer" }, { - "description": "the account associated with the tag", - "name": "account", - "type": "string" + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + } + ], + "type": "set" } ], "type": "set" }, { - "description": "the ID of the security group", - "name": "id", + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" + }, + { + "description": "the name of the security group", + "name": "name", "type": "string" }, { @@ -22720,22 +23713,27 @@ "name": "egressrule", "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 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": "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", "type": "string" }, { @@ -22744,23 +23742,23 @@ "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "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 ID of the domain associated with the tag", - "name": "domainid", + "description": "tag key name", + "name": "key", "type": "string" }, { @@ -22769,26 +23767,21 @@ "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the account associated with the tag", + "name": "account", "type": "string" } ], "type": "set" }, { - "description": "the id of the security group rule", - "name": "ruleid", + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", "type": "string" }, { - "description": "the protocol of the security group rule", - "name": "protocol", + "description": "security group name", + "name": "securitygroupname", "type": "string" }, { @@ -22797,13 +23790,8 @@ "type": "integer" }, { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, - { - "description": "security group name", - "name": "securitygroupname", + "description": "the id of the security group rule", + "name": "ruleid", "type": "string" }, { @@ -22812,8 +23800,13 @@ "type": "integer" }, { - "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 ending IP of the security group rule ", + "name": "endport", "type": "integer" }, { @@ -22825,391 +23818,148 @@ "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" - } - ], - "type": "set" - }, - { - "description": "the read (bytes) of disk on the vm", - "name": "diskkbsread", - "type": "long" - }, - { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", - "type": "boolean" - }, - { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", - "type": "string" - }, - { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", - "type": "string" - }, - { - "description": "the project name of the vm", - "name": "project", - "type": "string" - }, - { - "description": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", - "response": [ - { - "description": "the project name of the affinity group", - "name": "project", - "type": "string" - }, - { - "description": "the domain ID of the affinity group", - "name": "domainid", - "type": "string" - }, - { - "description": "the project ID of the affinity group", - "name": "projectid", - "type": "string" - }, - { - "description": "the description of the affinity group", - "name": "description", - "type": "string" - }, - { - "description": "the type of the affinity group", - "name": "type", - "type": "string" - }, - { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" - }, - { - "description": "the account owning the affinity group", - "name": "account", - "type": "string" - }, - { - "description": "the name of the affinity group", - "name": "name", - "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" - } - ], - "type": "set" - }, - { - "description": "OS type id of the vm", - "name": "ostypeid", - "type": "string" - }, - { - "description": "ssh key-pair", - "name": "keypair", - "type": "string" - }, - { - "description": "the project id of the vm", - "name": "projectid", - "type": "string" - }, - { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" - }, - { - "description": "the group name of the virtual machine", - "name": "group", - "type": "string" - }, - { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", - "type": "string" - }, - { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" - }, - { - "description": "Guest vm Boot Type", - "name": "boottype", - "type": "string" - }, - { - "description": "the incoming network traffic on the vm", - "name": "networkkbsread", - "type": "long" - }, - { - "description": "the write (io) of disk on the vm", - "name": "diskiowrite", - "type": "long" - }, - { - "description": "the speed of each cpu", - "name": "cpuspeed", - "type": "integer" - }, - { - "description": "the list of resource tags associated", - "name": "tags", - "response": [ - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "the account associated with the tag", + "description": "the account owning the security group", "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": "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", + "description": "the project id of the group", "name": "projectid", "type": "string" }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" - }, - { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" - }, - { - "description": "the 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": "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 name of the service offering of the virtual machine", - "name": "serviceofferingname", - "type": "string" - }, - { - "description": "the ID of the virtual machine", - "name": "id", - "type": "string" - }, - { - "description": "the name of the host for the virtual machine", - "name": "hostname", - "type": "string" - }, - { - "description": "the vgpu type used by the virtual machine", - "name": "vgpu", - "type": "string" - }, - {}, - { - "description": "the ID of the host for the virtual machine", - "name": "hostid", - "type": "string" - }, - { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", - "type": "string" - }, - { - "description": "the password (if exists) of the virtual machine", - "name": "password", - "type": "string" - }, - { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", - "type": "string" + { + "description": "the project name of the group", + "name": "project", + "type": "string" + }, + { + "description": "the domain name of the security group", + "name": "domain", + "type": "string" + } + ], + "type": "set" }, { - "description": "the number of cpu this virtual machine is running with", - "name": "cpunumber", + "description": "the speed of each vCPU", + "name": "cpuspeed", "type": "integer" }, { - "description": "the name of the virtual machine", - "name": "name", - "type": "string" + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" }, { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", - "type": "boolean" + "description": "ssh key-pairs", + "name": "keypairs", + "type": "string" }, { - "description": "the memory used by the vm", - "name": "memorykbs", + "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", - "type": "string" - }, - { - "description": "Os type ID of the virtual machine", - "name": "guestosid", + "description": "the pool type of the virtual machine", + "name": "pooltype", "type": "string" }, { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" + "description": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", + "response": [ + { + "description": "the project ID of the affinity group", + "name": "projectid", + "type": "string" + }, + { + "description": "the description of the affinity group", + "name": "description", + "type": "string" + }, + { + "description": "the project name of the affinity group", + "name": "project", + "type": "string" + }, + { + "description": "the account owning the affinity group", + "name": "account", + "type": "string" + }, + { + "description": "the domain ID of the affinity group", + "name": "domainid", + "type": "string" + }, + { + "description": "the domain name of the affinity group", + "name": "domain", + "type": "string" + }, + { + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" + }, + { + "description": "the ID of the affinity group", + "name": "id", + "type": "string" + }, + { + "description": "the name of the affinity group", + "name": "name", + "type": "string" + }, + { + "description": "the type of the affinity group", + "name": "type", + "type": "string" + } + ], + "type": "set" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "State of the Service from LB rule", + "name": "servicestate", "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" - }, - { - "description": "the write (bytes) of disk on the vm", - "name": "diskkbswrite", + "description": "the VM's disk read in KiB", + "name": "diskkbsread", "type": "long" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", - "type": "string" - }, - { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", + "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 name of the template for the virtual machine", - "name": "templatename", - "type": "string" - }, - { - "description": "State of the Service from LB rule", - "name": "servicestate", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the ID of the availablility zone for the virtual machine", - "name": "zoneid", + "description": "the project id of the vm", + "name": "projectid", "type": "string" }, { - "description": "the outgoing network traffic on the host", - "name": "networkkbswrite", + "description": "device ID of the root volume", + "name": "rootdeviceid", "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": "device ID of the root volume", - "name": "rootdeviceid", + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", "type": "long" } ] @@ -23219,14 +23969,6 @@ "isasync": true, "name": "updateLBStickinessPolicy", "params": [ - { - "description": "an optional field, whether to the display the policy to the end user or not", - "length": 255, - "name": "fordisplay", - "required": false, - "since": "4.4", - "type": "boolean" - }, { "description": "id of lb stickiness policy", "length": 255, @@ -23235,6 +23977,14 @@ "required": true, "type": "uuid" }, + { + "description": "an optional field, whether to the display the policy to the end user or not", + "length": 255, + "name": "fordisplay", + "required": false, + "since": "4.4", + "type": "boolean" + }, { "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", "length": 255, @@ -23247,81 +23997,35 @@ "related": "createLBStickinessPolicy,listLBStickinessPolicies", "response": [ { - "description": "the id of the zone the Stickiness policy belongs to", - "name": "zoneid", - "type": "string" - }, - { - "description": "the name of the Stickiness policy", - "name": "name", - "type": "string" - }, - { - "description": "the domain ID of the Stickiness policy", - "name": "domainid", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the LB rule ID", - "name": "lbruleid", - "type": "string" - }, - {}, - { - "description": "the domain of the Stickiness policy", - "name": "domain", + "description": "the description of the Stickiness policy", + "name": "description", "type": "string" }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "the account of the Stickiness policy", "name": "account", "type": "string" }, + {}, { - "description": "the description of the Stickiness policy", - "name": "description", - "type": "string" - }, - { - "description": "the state of the policy", - "name": "state", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {}, { "description": "the list of stickinesspolicies", "name": "stickinesspolicy", "response": [ { - "description": "the LB Stickiness policy ID", - "name": "id", - "type": "string" - }, - { - "description": "the name of the Stickiness policy", - "name": "name", - "type": "string" + "description": "the params of the policy", + "name": "params", + "type": "map" }, { "description": "the state of the policy", "name": "state", "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", @@ -23333,12 +24037,58 @@ "type": "string" }, { - "description": "the params of the policy", - "name": "params", - "type": "map" + "description": "the LB Stickiness policy ID", + "name": "id", + "type": "string" + }, + { + "description": "the method name of the Stickiness policy", + "name": "methodname", + "type": "string" + }, + { + "description": "the name of the Stickiness policy", + "name": "name", + "type": "string" } ], "type": "list" + }, + { + "description": "the LB rule ID", + "name": "lbruleid", + "type": "string" + }, + {}, + { + "description": "the name of the Stickiness policy", + "name": "name", + "type": "string" + }, + { + "description": "the domain ID of the Stickiness policy", + "name": "domainid", + "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 domain of the Stickiness policy", + "name": "domain", + "type": "string" + }, + { + "description": "the id of the zone the Stickiness policy belongs to", + "name": "zoneid", + "type": "string" } ], "since": "4.4" @@ -23349,26 +24099,18 @@ "name": "listPods", "params": [ { - "description": "list pods by allocation state", - "length": 255, - "name": "allocationstate", - "required": false, - "type": "string" - }, - { - "description": "list Pods by Zone ID", + "description": "", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "", + "description": "list pods by allocation state", "length": 255, - "name": "pagesize", + "name": "allocationstate", "required": false, - "type": "integer" + "type": "string" }, { "description": "list Pods by name", @@ -23386,11 +24128,12 @@ "type": "uuid" }, { - "description": "", + "description": "list Pods by Zone ID", "length": 255, - "name": "page", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, - "type": "integer" + "type": "uuid" }, { "description": "flag to display the capacity of the pods", @@ -23405,244 +24148,74 @@ "name": "keyword", "required": false, "type": "string" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" } ], "related": "updatePod,createManagementNetworkIpRange", "response": [ - { - "description": "the ID of the Pod", - "name": "id", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, { "description": "the gateway of the Pod", "name": "gateway", "type": "string" }, - { - "description": "the starting IP for the Pod. This parameter is deprecated, please use 'startip' from ipranges parameter.", - "name": "startip", - "type": "list" - }, { "description": "the IP ranges for the Pod", "name": "ipranges", "response": [ { - "description": "the ending IP for the range", - "name": "endip", - "type": "string" - }, - { - "description": "indicates Vlan ID for the range", - "name": "vlanid", - "type": "string" - }, - { - "description": "the starting IP for the range", - "name": "startip", + "description": "the gateway for the range", + "name": "gateway", "type": "string" }, { "description": "indicates if range is dedicated for CPVM and SSVM", "name": "forsystemvms", "type": "string" - } - ], - "type": "list" - }, - { - "description": "the name of the Pod", - "name": "name", - "type": "string" - }, - {}, - { - "description": "indicates if range is dedicated for CPVM and SSVM. This parameter is deprecated, please use 'forsystemvms' from ipranges parameter.", - "name": "forsystemvms", - "type": "list" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the Zone name of the Pod", - "name": "zonename", - "type": "string" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - {}, - { - "description": "the Zone ID of the Pod", - "name": "zoneid", - "type": "string" - }, - { - "description": "the allocation state of the Pod", - "name": "allocationstate", - "type": "string" - }, - { - "description": "the netmask of the Pod", - "name": "netmask", - "type": "string" - }, - { - "description": "indicates Vlan ID for the range. This parameter is deprecated, please use 'vlanid' from ipranges parameter.", - "name": "vlanid", - "type": "list" - }, - { - "description": "the ending IP for the Pod. This parameter is deprecated, please use 'endip' from ipranges parameter.", - "name": "endip", - "type": "list" - }, - { - "description": "the capacity of the Pod", - "name": "capacity", - "response": [ - { - "description": "the percentage of capacity currently in use", - "name": "percentused", - "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 Cluster ID", - "name": "clusterid", - "type": "string" - }, - { - "description": "the Pod ID", - "name": "podid", - "type": "string" - }, - { - "description": "the total capacity available", - "name": "capacitytotal", - "type": "long" }, { - "description": "the capacity name", - "name": "name", + "description": "the CIDR for the range", + "name": "cidr", "type": "string" }, { - "description": "the Pod name", - "name": "podname", + "description": "the ending IP for the range", + "name": "endip", "type": "string" }, - { - "description": "the capacity currently in use", - "name": "capacityused", - "type": "long" - }, - { - "description": "the Zone name", - "name": "zonename", - "type": "string" - } - ], - "type": "list" - } - ] - }, - { - "description": "Starts an existing internal lb vm.", - "isasync": true, - "name": "startInternalLoadBalancerVM", - "params": [ - { - "description": "the ID of the internal lb vm", - "length": 255, - "name": "id", - "related": "destroyRouter,listRouters,rebootRouter,changeServiceForRouter,stopInternalLoadBalancerVM,startInternalLoadBalancerVM,listInternalLoadBalancerVMs,stopNetScalerVpx", - "required": true, - "type": "uuid" - } - ], - "related": "destroyRouter,listRouters,rebootRouter,changeServiceForRouter,stopInternalLoadBalancerVM,listInternalLoadBalancerVMs,stopNetScalerVpx", - "response": [ - { - "description": "the hostname for the router", - "name": "hostname", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "if this router is an redundant virtual router", - "name": "isredundantrouter", - "type": "boolean" - }, - { - "description": "the Zone name for the router", - "name": "zonename", - "type": "string" - }, - {}, - { - "description": "the public netmask for the router", - "name": "publicnetmask", - "type": "string" - }, - { - "description": "the ID of the corresponding guest network", - "name": "guestnetworkid", - "type": "string" - }, - { - "description": "the ID of the corresponding public network", - "name": "publicnetworkid", - "type": "string" + { + "description": "indicates Vlan ID for the range", + "name": "vlanid", + "type": "string" + }, + { + "description": "the starting IP for the range", + "name": "startip", + "type": "string" + } + ], + "type": "list" }, + {}, { - "description": "the version of template", - "name": "version", + "description": "the ID of the Pod", + "name": "id", "type": "string" }, { - "description": "the domain associated with the router", - "name": "domain", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the Zone ID for the router", - "name": "zoneid", - "type": "string" + "description": "indicates Vlan ID for the range. This parameter is deprecated, please use 'vlanid' from ipranges parameter.", + "name": "vlanid", + "type": "list" }, { "description": "true if the entity/resource has annotations", @@ -23650,105 +24223,149 @@ "type": "boolean" }, { - "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": "indicates if range is dedicated for CPVM and SSVM. This parameter is deprecated, please use 'forsystemvms' from ipranges parameter.", + "name": "forsystemvms", + "type": "list" }, { - "description": "the state of redundant virtual router", - "name": "redundantstate", + "description": "the Zone name of the Pod", + "name": "zonename", "type": "string" }, { - "description": "Last executed health check result for the router", - "name": "healthcheckresults", + "description": "the capacity of the Pod", + "name": "capacity", "response": [ { - "description": "the date this VPC was created", - "name": "lastupdated", - "type": "date" + "description": "the Pod ID", + "name": "podid", + "type": "string" }, { - "description": "detailed response generated on running health check", - "name": "details", + "description": "the Cluster name", + "name": "clustername", "type": "string" }, { - "description": "the type of the health check - basic or advanced", - "name": "checktype", + "description": "the capacity currently in use", + "name": "capacityused", + "type": "long" + }, + { + "description": "the Pod name", + "name": "podname", "type": "string" }, { - "description": "result of the health check", - "name": "success", - "type": "boolean" + "description": "the Cluster ID", + "name": "clusterid", + "type": "string" }, { - "description": "the name of the health check on the router", - "name": "checkname", + "description": "the capacity name", + "name": "name", + "type": "string" + }, + { + "description": "the Zone name", + "name": "zonename", + "type": "string" + }, + { + "description": "the capacity type", + "name": "type", + "type": "short" + }, + { + "description": "the Zone ID", + "name": "zoneid", + "type": "string" + }, + { + "description": "the capacity currently in allocated", + "name": "capacityallocated", + "type": "long" + }, + { + "description": "the percentage of capacity currently in use", + "name": "percentused", "type": "string" + }, + { + "description": "the total capacity available", + "name": "capacitytotal", + "type": "long" } ], "type": "list" }, { - "description": "the account associated with the router", - "name": "account", + "description": "the netmask of the Pod", + "name": "netmask", "type": "string" }, { - "description": "the ID of the corresponding link local network", - "name": "linklocalnetworkid", + "description": "the allocation state of the Pod", + "name": "allocationstate", "type": "string" }, { - "description": "the version of scripts", - "name": "scriptsversion", + "description": "the Zone ID of the Pod", + "name": "zoneid", "type": "string" }, { - "description": "the template name for the router", - "name": "templatename", + "description": "the name of the Pod", + "name": "name", "type": "string" }, { - "description": "the name of VPC the router belongs to", - "name": "vpcname", - "type": "string" + "description": "the ending IP for the Pod. This parameter is deprecated, please use 'endip' from ipranges parameter.", + "name": "endip", + "type": "list" }, { - "description": "the id of the router", - "name": "id", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the public IP address for the router", - "name": "publicip", - "type": "string" + "description": "the starting IP for the Pod. This parameter is deprecated, please use 'startip' from ipranges parameter.", + "name": "startip", + "type": "list" }, + {} + ] + }, + { + "description": "Starts an existing internal lb vm.", + "isasync": true, + "name": "startInternalLoadBalancerVM", + "params": [ { - "description": "the network domain for the router", - "name": "networkdomain", - "type": "string" - }, + "description": "the ID of the internal lb vm", + "length": 255, + "name": "id", + "related": "destroyRouter,listRouters,rebootRouter,changeServiceForRouter,stopInternalLoadBalancerVM,startInternalLoadBalancerVM,listInternalLoadBalancerVMs,stopNetScalerVpx", + "required": true, + "type": "uuid" + } + ], + "related": "destroyRouter,listRouters,rebootRouter,changeServiceForRouter,stopInternalLoadBalancerVM,listInternalLoadBalancerVMs,stopNetScalerVpx", + "response": [ { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the version of template", + "name": "version", "type": "string" }, { - "description": "the guest netmask for the router", - "name": "guestnetmask", + "description": "the name of the corresponding guest network", + "name": "guestnetworkname", "type": "string" }, { - "description": "the guest MAC address for the router", - "name": "guestmacaddress", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, { @@ -23757,82 +24374,57 @@ "type": "string" }, { - "description": "the link local netmask for the router", - "name": "linklocalnetmask", - "type": "string" - }, - { - "description": "the name of the corresponding guest network", - "name": "guestnetworkname", - "type": "string" - }, - { - "description": "the first IPv6 DNS for the router", - "name": "ip6dns1", + "description": "the version of scripts", + "name": "scriptsversion", "type": "string" }, { - "description": "the domain ID associated with the router", - "name": "domainid", + "description": "the template ID for the router", + "name": "templateid", "type": "string" }, { - "description": "the gateway for the router", - "name": "gateway", - "type": "string" + "description": "true if the router template requires upgrader", + "name": "requiresupgrade", + "type": "boolean" }, { "description": "the list of nics associated with the router", "name": "nic", "response": [ - { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", - "type": "string" - }, { "description": "the ID of the nic", "name": "id", "type": "string" }, - { - "description": "the IPv6 address of network", - "name": "ip6address", - "type": "string" - }, { "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", "name": "nsxlogicalswitchport", "type": "string" }, { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" + "description": "the netmask of the nic", + "name": "netmask", + "type": "string" }, { - "description": "the type of the nic", - "name": "type", + "description": "the ip address of the nic", + "name": "ipaddress", "type": "string" }, { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" + "description": "the isolation uri of the nic", + "name": "isolationuri", + "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", + "type": "string" }, { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", "type": "list" }, { @@ -23846,43 +24438,53 @@ "type": "string" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "the IPv6 address of network", + "name": "ip6address", "type": "string" }, { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "the name of the corresponding network", + "name": "networkname", "type": "string" }, { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", "type": "string" }, { - "description": "the netmask of the nic", - "name": "netmask", + "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": "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 isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "the type of the nic", + "name": "type", "type": "string" }, { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "true if nic is default, false otherwise", + "name": "macaddress", "type": "string" }, { @@ -23891,46 +24493,61 @@ "type": "string" }, { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", + "type": "string" }, { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "the traffic type of the nic", + "name": "traffictype", "type": "string" }, { - "description": "the ip address of the nic", - "name": "ipaddress", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "the ID of the corresponding network", + "name": "networkid", + "type": "string" + }, + { + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "type": "string" } ], "type": "set" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "the name of the router", + "name": "name", "type": "string" }, { - "description": "the project name of the address", - "name": "project", + "description": "the state of redundant virtual router", + "name": "redundantstate", "type": "string" }, { - "description": "the guest IP address for the router", - "name": "guestipaddress", + "description": "the Zone ID for the router", + "name": "zoneid", "type": "string" }, { @@ -23939,58 +24556,222 @@ "type": "state" }, { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "the date and time the router was created", + "name": "created", + "type": "date" + }, + { + "description": "the second IPv6 DNS for the router", + "name": "ip6dns2", "type": "string" }, + {}, { - "description": "the second DNS for the router", - "name": "dns2", + "description": "the public MAC address for the router", + "name": "publicmacaddress", "type": "string" }, { - "description": "the template ID for the router", - "name": "templateid", + "description": "the link local netmask for the router", + "name": "linklocalnetmask", "type": "string" }, { - "description": "the second IPv6 DNS for the router", - "name": "ip6dns2", + "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 guest netmask for the router", + "name": "guestnetmask", + "type": "string" + }, + { + "description": "role of the domain router", + "name": "role", + "type": "string" + }, + { + "description": "the guest IP address for the router", + "name": "guestipaddress", + "type": "string" + }, + { + "description": "the public IP address for the router", + "name": "publicip", "type": "string" }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, { "description": "the link local MAC address for the router", "name": "linklocalmacaddress", "type": "string" }, + { + "description": "the domain associated with the router", + "name": "domain", + "type": "string" + }, + { + "description": "the guest MAC address for the router", + "name": "guestmacaddress", + "type": "string" + }, + { + "description": "the name of VPC the router belongs to", + "name": "vpcname", + "type": "string" + }, + { + "description": "true if any health checks had failed", + "name": "healthchecksfailed", + "type": "boolean" + }, + { + "description": "if this router is an redundant virtual router", + "name": "isredundantrouter", + "type": "boolean" + }, + { + "description": "the domain ID associated with the router", + "name": "domainid", + "type": "string" + }, + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the first DNS for the router", + "name": "dns1", + "type": "string" + }, + { + "description": "the hostname for the router", + "name": "hostname", + "type": "string" + }, + { + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", + "type": "string" + }, + { + "description": "the project id of the ipaddress", + "name": "projectid", + "type": "string" + }, { "description": "the link local IP address for the router", "name": "linklocalip", "type": "string" }, + { + "description": "VPC the router belongs to", + "name": "vpcid", + "type": "string" + }, + { + "description": "the ID of the corresponding guest network", + "name": "guestnetworkid", + "type": "string" + }, + { + "description": "Last executed health check result for the router", + "name": "healthcheckresults", + "response": [ + { + "description": "the name of the health check on the router", + "name": "checkname", + "type": "string" + }, + { + "description": "result of the health check", + "name": "success", + "type": "boolean" + }, + { + "description": "the type of the health check - basic or advanced", + "name": "checktype", + "type": "string" + }, + { + "description": "the date this VPC was created", + "name": "lastupdated", + "type": "date" + }, + { + "description": "detailed response generated on running health check", + "name": "details", + "type": "string" + } + ], + "type": "list" + }, + { + "description": "the network domain for the router", + "name": "networkdomain", + "type": "string" + }, + { + "description": "the ID of the corresponding link local network", + "name": "linklocalnetworkid", + "type": "string" + }, + { + "description": "the ID of the corresponding public network", + "name": "publicnetworkid", + "type": "string" + }, + { + "description": "the first IPv6 DNS for the router", + "name": "ip6dns1", + "type": "string" + }, + { + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" + }, { "description": "the Pod name for the router", "name": "podname", "type": "string" }, { - "description": "role of the domain router", - "name": "role", + "description": "the id of the router", + "name": "id", "type": "string" }, { - "description": "the name of the router", - "name": "name", + "description": "the gateway for the router", + "name": "gateway", + "type": "string" + }, + { + "description": "the template name for the router", + "name": "templatename", "type": "string" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "the second DNS for the router", + "name": "dns2", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the public netmask for the router", + "name": "publicnetmask", "type": "string" }, { @@ -23999,25 +24780,19 @@ "type": "string" }, { - "description": "VPC the router belongs to", - "name": "vpcid", + "description": "the version of the code / software in the router", + "name": "softwareversion", "type": "string" }, { - "description": "the public MAC address for the router", - "name": "publicmacaddress", + "description": "the Zone name for the router", + "name": "zonename", "type": "string" }, { - "description": "true if the router template requires upgrader", - "name": "requiresupgrade", - "type": "boolean" - }, - {}, - { - "description": "true if any health checks had failed", - "name": "healthchecksfailed", - "type": "boolean" + "description": "the account associated with the router", + "name": "account", + "type": "string" } ] }, @@ -24027,44 +24802,60 @@ "name": "updateDiskOffering", "params": [ { - "description": "length (in seconds) of the burst", + "description": "io requests read rate of the disk offering", "length": 255, - "name": "iopsreadratemaxlength", + "name": "iopsreadrate", "required": false, "since": "4.15", "type": "long" }, { - "description": "io requests write rate of the disk offering", + "description": "sort key of the disk offering, integer", "length": 255, - "name": "iopswriterate", + "name": "sortkey", "required": false, - "since": "4.15", - "type": "long" + "type": "integer" }, { - "description": "updates name of the disk offering with this value", + "description": "burst bytes write rate of the disk offering", "length": 255, - "name": "name", + "name": "byteswriteratemax", "required": false, - "type": "string" + "since": "4.15", + "type": "long" }, { - "description": "bytes write rate of the disk offering", + "description": "burst io requests write rate of the disk offering", "length": 255, - "name": "byteswriterate", + "name": "iopswriteratemax", "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", + "description": "the ID of the containing zone(s) as comma separated string, all for all zones offerings", + "length": 255, + "name": "zoneid", "required": false, "since": "4.13", "type": "string" }, + { + "description": "length (in seconds) of the burst", + "length": 255, + "name": "bytesreadratemaxlength", + "required": false, + "since": "4.15", + "type": "long" + }, + { + "description": "ID of the disk offering", + "length": 255, + "name": "id", + "related": "createDiskOffering,updateDiskOffering,listDiskOfferings", + "required": true, + "type": "uuid" + }, { "description": "the cache mode to use for this disk offering", "length": 255, @@ -24074,25 +24865,24 @@ "type": "string" }, { - "description": "io requests read rate of the disk offering", + "description": "comma-separated list of tags for the disk offering, tags should match with existing storage pool tags", "length": 255, - "name": "iopsreadrate", + "name": "tags", "required": false, "since": "4.15", - "type": "long" + "type": "string" }, { - "description": "burst io requests write rate of the disk offering", + "description": "updates name of the disk offering with this value", "length": 255, - "name": "iopswriteratemax", + "name": "name", "required": false, - "since": "4.15", - "type": "long" + "type": "string" }, { "description": "length (in seconds) of the burst", "length": 255, - "name": "bytesreadratemaxlength", + "name": "iopswriteratemaxlength", "required": false, "since": "4.15", "type": "long" @@ -24105,34 +24895,35 @@ "type": "string" }, { - "description": "the ID of the containing zone(s) as comma separated string, all for all zones offerings", + "description": "an optional field, whether to display the offering to the end user or not.", "length": 255, - "name": "zoneid", + "name": "displayoffering", "required": false, - "since": "4.13", - "type": "string" + "type": "boolean" }, { - "description": "sort key of the disk offering, integer", + "description": "length (in seconds) of the burst", "length": 255, - "name": "sortkey", + "name": "byteswriteratemaxlength", "required": false, - "type": "integer" + "since": "4.15", + "type": "long" }, { - "description": "burst bytes write rate of the disk offering", + "description": "burst bytes read rate of the disk offering", "length": 255, - "name": "byteswriteratemax", + "name": "bytesreadratemax", "required": false, "since": "4.15", "type": "long" }, { - "description": "an optional field, whether to display the offering to the end user or not.", + "description": "bytes write rate of the disk offering", "length": 255, - "name": "displayoffering", + "name": "byteswriterate", "required": false, - "type": "boolean" + "since": "4.15", + "type": "long" }, { "description": "burst requests read rate of the disk offering", @@ -24145,67 +24936,41 @@ { "description": "length (in seconds) of the burst", "length": 255, - "name": "byteswriteratemaxlength", + "name": "iopsreadratemaxlength", "required": false, "since": "4.15", "type": "long" }, { - "description": "ID of the disk offering", - "length": 255, - "name": "id", - "related": "createDiskOffering,updateDiskOffering,listDiskOfferings", - "required": true, - "type": "uuid" - }, - { - "description": "length (in seconds) of the burst", + "description": "bytes read rate of the disk offering", "length": 255, - "name": "iopswriteratemaxlength", + "name": "bytesreadrate", "required": false, "since": "4.15", "type": "long" }, { - "description": "comma-separated list of tags for the disk offering, tags should match with existing storage pool tags", - "length": 255, - "name": "tags", - "required": false, - "since": "4.15", - "type": "string" - }, - { - "description": "bytes read rate of the disk offering", + "description": "io requests write rate of the disk offering", "length": 255, - "name": "bytesreadrate", + "name": "iopswriterate", "required": false, "since": "4.15", "type": "long" }, { - "description": "burst bytes read rate of the disk offering", - "length": 255, - "name": "bytesreadratemax", + "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": "long" + "since": "4.13", + "type": "string" } ], "related": "createDiskOffering,listDiskOfferings", "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": "the max iops of the disk offering", - "name": "maxiops", - "type": "long" - }, - { - "description": "bytes read rate of the disk offering", - "name": "diskBytesReadRate", + "description": "bytes write rate of the disk offering", + "name": "diskBytesWriteRate", "type": "long" }, { @@ -24214,106 +24979,105 @@ "type": "long" }, { - "description": "the storage type for this disk offering", - "name": "storagetype", - "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 vsphere storage policy tagged to the disk offering in case of VMware", - "name": "vspherestoragepolicy", + "description": "the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "zone", "type": "string" }, { - "description": "the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "domain", - "type": "string" + "description": "true if disk offering uses custom size, false otherwise", + "name": "iscustomized", + "type": "boolean" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "io requests write rate of the disk offering", + "name": "diskIopsWriteRate", + "type": "long" }, { - "description": "the size of the disk offering in GB", - "name": "disksize", - "type": "long" + "description": "the tags for the disk offering", + "name": "tags", + "type": "string" }, - {}, { - "description": "burst bytes read rate of the disk offering", - "name": "diskBytesReadRateMax", + "description": "length (in seconds) of the burst", + "name": "diskIopsWriteRateMaxLength", "type": "long" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "true if disk offering uses custom iops, false otherwise", + "name": "iscustomizediops", "type": "boolean" }, { - "description": "length (in seconds) of the burst", - "name": "diskBytesReadRateMaxLength", + "description": "length (in second) of the burst", + "name": "diskIopsReadRateMaxLength", "type": "long" }, + {}, { - "description": "io requests write rate of the disk offering", - "name": "diskIopsWriteRate", + "description": "burst bytes write rate of the disk offering", + "name": "diskBytesWriteRateMax", "type": "long" }, { - "description": "bytes write rate of the disk offering", - "name": "diskBytesWriteRate", + "description": "length (in seconds) of the burst", + "name": "diskBytesWriteRateMaxLength", "type": "long" }, { - "description": "an alternate display text of the disk offering.", - "name": "displaytext", + "description": "the storage type for this disk offering", + "name": "storagetype", "type": "string" }, { - "description": "provisioning type used to create volumes. Valid values are thin, sparse, fat.", - "name": "provisioningtype", - "type": "string" + "description": "io requests read rate of the disk offering", + "name": "diskIopsReadRate", + "type": "long" }, { - "description": "length (in seconds) of the burst", - "name": "diskIopsWriteRateMaxLength", + "description": "the min iops of the disk offering", + "name": "miniops", "type": "long" }, { - "description": "true if disk offering uses custom size, false otherwise", - "name": "iscustomized", + "description": "whether to display the offering to the end user or not.", + "name": "displayoffering", "type": "boolean" }, { - "description": "the tags for the disk offering", - "name": "tags", + "description": "provisioning type used to create volumes. Valid values are thin, sparse, fat.", + "name": "provisioningtype", "type": "string" }, { - "description": "the min iops of the disk offering", - "name": "miniops", + "description": "the max iops of the disk offering", + "name": "maxiops", "type": "long" }, { - "description": "burst bytes write rate of the disk offering", - "name": "diskBytesWriteRateMax", - "type": "long" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "whether to display the offering to the end user or not.", - "name": "displayoffering", - "type": "boolean" + "description": "burst bytes read rate of the disk offering", + "name": "diskBytesReadRateMax", + "type": "long" }, - {}, { - "description": "the name of the disk offering", - "name": "name", + "description": "an alternate display text of the disk offering.", + "name": "displaytext", "type": "string" }, { - "description": "length (in seconds) of the burst", - "name": "diskBytesWriteRateMaxLength", - "type": "long" + "description": "the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "domain", + "type": "string" }, { "description": "burst io requests write rate of the disk offering", @@ -24326,49 +25090,65 @@ "type": "string" }, { - "description": "the date this disk offering was created", - "name": "created", - "type": "date" + "description": "the name of the disk offering", + "name": "name", + "type": "string" }, { - "description": "io requests read rate of the disk offering", - "name": "diskIopsReadRate", + "description": "the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "domainid", + "type": "string" + }, + { + "description": "bytes read rate of the disk offering", + "name": "diskBytesReadRate", "type": "long" }, + {}, { - "description": "the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zone", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the vsphere storage policy tagged to the disk offering in case of VMware", + "name": "vspherestoragepolicy", "type": "string" }, { - "description": "the cache mode to use for this disk offering. none, writeback or writethrough", - "name": "cacheMode", + "description": "Hypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware)", + "name": "hypervisorsnapshotreserve", + "type": "integer" + }, + { + "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "zoneid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the cache mode to use for this disk offering. none, writeback or writethrough", + "name": "cacheMode", "type": "string" }, { - "description": "true if disk offering uses custom iops, false otherwise", - "name": "iscustomizediops", - "type": "boolean" + "description": "length (in seconds) of the burst", + "name": "diskBytesReadRateMaxLength", + "type": "long" }, { - "description": "Hypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware)", - "name": "hypervisorsnapshotreserve", - "type": "integer" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "length (in second) of the burst", - "name": "diskIopsReadRateMaxLength", + "description": "the size of the disk offering in GB", + "name": "disksize", "type": "long" }, { - "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zoneid", - "type": "string" + "description": "the date this disk offering was created", + "name": "created", + "type": "date" } ] }, @@ -24387,27 +25167,27 @@ } ], "response": [ - {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" + }, + {}, + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ] }, @@ -24426,28 +25206,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", + "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" }, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" - }, - {}, - {} + } ] }, { @@ -24462,14 +25242,6 @@ "required": false, "type": "string" }, - { - "description": "ID of the project role", - "length": 255, - "name": "projectroleid", - "related": "createProjectRole,listProjectRoles,updateProjectRole", - "required": false, - "type": "uuid" - }, { "description": "ID of the project to add the account to", "length": 255, @@ -24491,30 +25263,38 @@ "name": "account", "required": false, "type": "string" + }, + { + "description": "ID of the project role", + "length": 255, + "name": "projectroleid", + "related": "createProjectRole,listProjectRoles,updateProjectRole", + "required": false, + "type": "uuid" } ], "response": [ - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, {}, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" }, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" } ], "since": "3.0.0" @@ -24525,11 +25305,27 @@ "name": "listSnapshots", "params": [ { - "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": "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": "", @@ -24539,9 +25335,17 @@ "type": "integer" }, { - "description": "valid values are HOURLY, DAILY, WEEKLY, and MONTHLY.", + "description": "list snapshots by zone id", "length": 255, - "name": "intervaltype", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": false, + "type": "uuid" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", "required": false, "type": "string" }, @@ -24560,95 +25364,127 @@ "type": "string" }, { - "description": "the IDs of the snapshots, mutually exclusive with id", + "description": "valid values are MANUAL or RECURRING.", "length": 255, - "name": "ids", - "related": "createSnapshot,createSnapshotFromVMSnapshot,archiveSnapshot,listSnapshots,revertSnapshot", + "name": "snapshottype", "required": false, - "since": "4.9", - "type": "list" + "type": "string" }, { - "description": "the ID of the disk volume", + "description": "lists snapshot by snapshot ID", "length": 255, - "name": "volumeid", - "related": "attachVolume,createVolume,updateVolume,detachVolume,listVolumes,migrateVolume,resizeVolume,destroyVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", + "name": "id", + "related": "createSnapshot,createSnapshotFromVMSnapshot,archiveSnapshot,listSnapshots,revertSnapshot", "required": false, "type": "uuid" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "isrecursive", + "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 resources by account. Must be used with the domainId parameter.", + "description": "", "length": 255, - "name": "account", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { - "description": "list only resources belonging to the domain specified", + "description": "valid values are HOURLY, DAILY, WEEKLY, and MONTHLY.", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", + "name": "intervaltype", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "list objects by project", + "description": "the IDs of the snapshots, mutually exclusive with id", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "name": "ids", + "related": "createSnapshot,createSnapshotFromVMSnapshot,archiveSnapshot,listSnapshots,revertSnapshot", "required": false, - "type": "uuid" + "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", + "description": "the ID of the disk volume", "length": 255, - "name": "listall", + "name": "volumeid", + "related": "attachVolume,createVolume,updateVolume,detachVolume,listVolumes,migrateVolume,resizeVolume,destroyVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", "required": false, + "type": "uuid" + } + ], + "related": "createSnapshot,createSnapshotFromVMSnapshot,archiveSnapshot,revertSnapshot", + "response": [ + { + "description": "indicates whether the underlying storage supports reverting the volume to this snapshot", + "name": "revertable", "type": "boolean" }, { - "description": "valid values are MANUAL or RECURRING.", - "length": 255, + "description": "display name of the os on volume", + "name": "osdisplayname", + "type": "string" + }, + { + "description": "the type of the snapshot", "name": "snapshottype", - "required": false, + "type": "string" + }, + {}, + { + "description": "physical size of backedup snapshot on image store", + "name": "physicalsize", + "type": "long" + }, + { + "description": "ID of the snapshot", + "name": "id", + "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": "the domain name of the snapshot's account", + "name": "domain", "type": "string" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" + "description": "virtual size of backedup snapshot on image store", + "name": "virtualsize", + "type": "long" }, { - "description": "list snapshots by zone id", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": false, - "type": "uuid" + "description": "name of the disk volume", + "name": "volumename", + "type": "string" }, { - "description": "lists snapshot by snapshot ID", - "length": 255, - "name": "id", - "related": "createSnapshot,createSnapshotFromVMSnapshot,archiveSnapshot,listSnapshots,revertSnapshot", - "required": false, - "type": "uuid" - } - ], - "related": "createSnapshot,createSnapshotFromVMSnapshot,archiveSnapshot,revertSnapshot", - "response": [ + "description": "the account associated with the snapshot", + "name": "account", + "type": "string" + }, { - "description": "id of the availability zone", - "name": "zoneid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -24656,13 +25492,13 @@ "name": "tags", "response": [ { - "description": "tag key name", - "name": "key", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "tag value", + "name": "value", "type": "string" }, { @@ -24671,13 +25507,13 @@ "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { @@ -24686,57 +25522,57 @@ "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the account associated with the tag", + "name": "account", "type": "string" } ], "type": "set" }, { - "description": "ID of the snapshot", - "name": "id", + "description": "valid types are hourly, daily, weekly, monthy, template, and none.", + "name": "intervaltype", "type": "string" }, { - "description": "id of the os on volume", - "name": "ostypeid", + "description": "id of the availability zone", + "name": "zoneid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the domain ID of the snapshot's account", + "name": "domainid", "type": "string" }, { - "description": "the project id of the snapshot", - "name": "projectid", + "description": "valid location types are primary and secondary.", + "name": "locationtype", "type": "string" }, {}, { - "description": " the date the snapshot was created", - "name": "created", - "type": "date" + "description": "id of the os on volume", + "name": "ostypeid", + "type": "string" }, { - "description": "ID of the disk volume", - "name": "volumeid", + "description": "name of the snapshot", + "name": "name", "type": "string" }, { @@ -24744,34 +25580,14 @@ "name": "project", "type": "string" }, - { - "description": "indicates whether the underlying storage supports reverting the volume to this snapshot", - "name": "revertable", - "type": "boolean" - }, - { - "description": "the domain name of the snapshot's account", - "name": "domain", - "type": "string" - }, - { - "description": "name of the disk volume", - "name": "volumename", - "type": "string" - }, { "description": "the state of the snapshot. BackedUp means that snapshot is ready to be used; Creating - the snapshot is being allocated on the primary storage; BackingUp - the snapshot is being backed up on secondary storage", "name": "state", "type": "state" }, { - "description": "the type of the snapshot", - "name": "snapshottype", - "type": "string" - }, - { - "description": "the account associated with the snapshot", - "name": "account", + "description": "ID of the disk volume", + "name": "volumeid", "type": "string" }, { @@ -24780,50 +25596,14 @@ "type": "string" }, { - "description": "name of the snapshot", - "name": "name", - "type": "string" - }, - { - "description": "physical size of backedup snapshot on image store", - "name": "physicalsize", - "type": "long" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "valid location types are primary and secondary.", - "name": "locationtype", - "type": "string" - }, - { - "description": "the domain ID of the snapshot's account", - "name": "domainid", + "description": "the project id of the snapshot", + "name": "projectid", "type": "string" }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - }, - { - "description": "virtual size of backedup snapshot on image store", - "name": "virtualsize", - "type": "long" - }, - {}, - { - "description": "display name of the os on volume", - "name": "osdisplayname", - "type": "string" - }, - { - "description": "valid types are hourly, daily, weekly, monthy, template, and none.", - "name": "intervaltype", - "type": "string" } ] }, @@ -24833,12 +25613,11 @@ "name": "resetVpnConnection", "params": [ { - "description": "an optional domainId for connection. If the account parameter is used, domainId must also be used.", + "description": "an optional account for connection. Must be used with domainId.", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", + "name": "account", "required": false, - "type": "uuid" + "type": "string" }, { "description": "id of vpn connection", @@ -24849,50 +25628,55 @@ "type": "uuid" }, { - "description": "an optional account for connection. Must be used with domainId.", + "description": "an optional domainId for connection. If the account parameter is used, domainId must also be used.", "length": 255, - "name": "account", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", "required": false, - "type": "string" + "type": "uuid" } ], "related": "createVpnConnection,listVpnConnections,updateVpnConnection", "response": [ { - "description": "Split multiple remote networks into multiple phase 2 SAs. Often used with Cisco some products.", - "name": "splitconnections", - "type": "boolean" - }, - { - "description": "the project id", - "name": "projectid", + "description": "guest cidr list of the customer gateway. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", "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": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the customer gateway ID", + "name": "s2scustomergatewayid", "type": "string" }, - {}, { - "description": "the vpn gateway ID", - "name": "s2svpngatewayid", + "description": "the project name", + "name": "project", "type": "string" }, { - "description": "the connection ID", - "name": "id", + "description": "Split multiple remote networks into multiple phase 2 SAs. Often used with Cisco some products.", + "name": "splitconnections", + "type": "boolean" + }, + { + "description": "State of vpn connection", + "name": "state", "type": "string" }, { - "description": "if DPD is enabled for customer gateway", - "name": "dpd", - "type": "boolean" + "description": "the domain id of the owner", + "name": "domainid", + "type": "string" + }, + { + "description": "the date and time the host was created", + "name": "created", + "type": "date" }, { "description": "the current status of the latest async job acting on this object", @@ -24905,34 +25689,30 @@ "type": "boolean" }, { - "description": "the domain name of the owner", - "name": "domain", - "type": "string" - }, - {}, - { - "description": "Lifetime of ESP SA of customer gateway", - "name": "esplifetime", + "description": "Lifetime of IKE SA of customer gateway", + "name": "ikelifetime", "type": "long" }, { - "description": "ESP policy of the customer gateway", - "name": "esppolicy", - "type": "string" + "description": "if Force NAT Encapsulation is enabled for customer gateway", + "name": "forceencap", + "type": "boolean" }, { - "description": "State of vpn connection", - "name": "state", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, { - "description": "the date and time the host was removed", - "name": "removed", - "type": "date" + "description": "the project id", + "name": "projectid", + "type": "string" }, + {}, { - "description": "the owner", - "name": "account", + "description": "the connection ID", + "name": "id", "type": "string" }, { @@ -24941,29 +25721,24 @@ "type": "string" }, { - "description": "the customer gateway ID", - "name": "s2scustomergatewayid", - "type": "string" - }, - { - "description": "public ip address id of the customer gateway", - "name": "gateway", + "description": "the vpn gateway ID", + "name": "s2svpngatewayid", "type": "string" }, { - "description": "the domain id of the owner", - "name": "domainid", + "description": "IKE policy of the customer gateway", + "name": "ikepolicy", "type": "string" }, { - "description": "guest cidr list of the customer gateway. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", + "description": "the domain name of the owner", + "name": "domain", "type": "string" }, { - "description": "the project name", - "name": "project", - "type": "string" + "description": "is connection for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, { "description": "IPsec Preshared-Key of the customer gateway", @@ -24971,28 +25746,33 @@ "type": "string" }, { - "description": "Lifetime of IKE SA of customer gateway", - "name": "ikelifetime", - "type": "long" + "description": "if DPD is enabled for customer gateway", + "name": "dpd", + "type": "boolean" }, { - "description": "is connection for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "the public IP address", + "name": "publicip", + "type": "string" }, { - "description": "if Force NAT Encapsulation is enabled for customer gateway", - "name": "forceencap", - "type": "boolean" + "description": "Lifetime of ESP SA of customer gateway", + "name": "esplifetime", + "type": "long" }, { - "description": "IKE policy of the customer gateway", - "name": "ikepolicy", + "description": "ESP policy of the customer gateway", + "name": "esppolicy", "type": "string" }, { - "description": "the public IP address", - "name": "publicip", + "description": "the owner", + "name": "account", + "type": "string" + }, + { + "description": "public ip address id of the customer gateway", + "name": "gateway", "type": "string" } ] @@ -25002,13 +25782,6 @@ "isasync": false, "name": "listKubernetesClusters", "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": "the ID of the Kubernetes cluster", "length": 255, @@ -25018,19 +25791,33 @@ "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": "name of the Kubernetes cluster (a substring match is made against the parameter value, data for all matching Kubernetes clusters will be returned)", + "description": "", "length": 255, - "name": "name", + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "description": "list resources by account. Must be used with the domainId parameter.", + "length": 255, + "name": "account", "required": false, "type": "string" }, + { + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "length": 255, + "name": "isrecursive", + "required": false, + "type": "boolean" + }, { "description": "state of the Kubernetes cluster", "length": 255, @@ -25046,26 +25833,20 @@ "type": "integer" }, { - "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 by keyword", + "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": "keyword", + "name": "name", "required": false, "type": "string" }, - { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, { "description": "list only resources belonging to the domain specified", "length": 255, @@ -25075,19 +25856,29 @@ "type": "uuid" }, { - "description": "list objects by project", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "name": "listall", "required": false, - "type": "uuid" + "type": "boolean" } ], "related": "createKubernetesCluster,startKubernetesCluster,scaleKubernetesCluster,upgradeKubernetesCluster", "response": [ { - "description": "the name of the Kubernetes version for the Kubernetes cluster", - "name": "kubernetesversionname", + "description": "the date when this Kubernetes cluster was created", + "name": "created", + "type": "date" + }, + { + "description": "URL end point for the Kubernetes cluster dashboard UI", + "name": "consoleendpoint", + "type": "string" + }, + {}, + { + "description": "the id of the Kubernetes cluster", + "name": "id", "type": "string" }, { @@ -25096,13 +25887,13 @@ "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "keypair details", + "name": "keypair", + "type": "string" }, { - "description": "Minimum size of the cluster", - "name": "minsize", + "description": "the control nodes count for the Kubernetes cluster", + "name": "controlnodes", "type": "long" }, { @@ -25110,39 +25901,24 @@ "name": "projectid", "type": "string" }, - { - "description": "Whether autoscaling is enabled for the cluster", - "name": "autoscalingenabled", - "type": "boolean" - }, - { - "description": "the id of the Kubernetes cluster", - "name": "id", - "type": "string" - }, - { - "description": "the name of the network of the Kubernetes cluster", - "name": "associatednetworkname", - "type": "string" - }, { "description": "Public IP Address ID of the cluster", "name": "ipaddressid", "type": "string" }, { - "description": "the ID of the Kubernetes version for the Kubernetes cluster", - "name": "kubernetesversionid", + "description": "the state of the Kubernetes cluster", + "name": "state", "type": "string" }, { - "description": "the account associated with the Kubernetes cluster", - "name": "account", + "description": "the name of the zone of the Kubernetes cluster", + "name": "zoneid", "type": "string" }, { - "description": "the name of the Kubernetes cluster", - "name": "name", + "description": "the ID of the domain in which the Kubernetes cluster exists", + "name": "domainid", "type": "string" }, { @@ -25151,40 +25927,29 @@ "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", + "description": "Whether autoscaling is enabled for the cluster", + "name": "autoscalingenabled", "type": "boolean" }, { - "description": "the project name of the Kubernetes cluster", - "name": "project", + "description": "the description of the Kubernetes cluster", + "name": "description", "type": "string" }, { - "description": "keypair details", - "name": "keypair", + "description": "URL end point for the Kubernetes cluster", + "name": "endpoint", "type": "string" }, { - "description": "the list of virtualmachine associated with this Kubernetes cluster", - "name": "virtualmachines", - "type": "list" - }, - {}, - { - "description": "Public IP Address of the cluster", - "name": "ipaddress", + "description": "the name of the service offering of the Kubernetes cluster", + "name": "serviceofferingname", "type": "string" }, { - "description": "the size (worker nodes count) of the Kubernetes cluster", - "name": "size", - "type": "long" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "the name of the domain in which the Kubernetes cluster exists", @@ -25192,13 +25957,18 @@ "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Public IP Address of the cluster", + "name": "ipaddress", "type": "string" }, { - "description": "the cpu cores of the Kubernetes cluster", - "name": "cpunumber", + "description": "the name of the Kubernetes version for the Kubernetes cluster", + "name": "kubernetesversionname", + "type": "string" + }, + { + "description": "the ID of the template of the Kubernetes cluster", + "name": "templateid", "type": "string" }, { @@ -25207,59 +25977,74 @@ "type": "long" }, { - "description": "the description of the Kubernetes cluster", - "name": "description", + "description": "the project name of the Kubernetes cluster", + "name": "project", "type": "string" }, + {}, { - "description": "URL end point for the Kubernetes cluster dashboard UI", - "name": "consoleendpoint", - "type": "string" + "description": "the master nodes count for the Kubernetes cluster. This parameter is deprecated, please use 'controlnodes' parameter.", + "name": "masternodes", + "type": "long" }, { - "description": "the name of the zone of the Kubernetes cluster", - "name": "zoneid", + "description": "the ID of the network of the Kubernetes cluster", + "name": "networkid", "type": "string" }, { - "description": "URL end point for the Kubernetes cluster", - "name": "endpoint", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the name of the Kubernetes cluster", + "name": "name", "type": "string" }, { - "description": "the name of the service offering of the Kubernetes cluster", - "name": "serviceofferingname", + "description": "the account associated with the Kubernetes cluster", + "name": "account", "type": "string" }, { - "description": "the ID of the network of the Kubernetes cluster", - "name": "networkid", + "description": "Minimum size of the cluster", + "name": "minsize", + "type": "long" + }, + { + "description": "the name of the zone of the Kubernetes cluster", + "name": "zonename", "type": "string" }, - {}, { - "description": "the state of the Kubernetes cluster", - "name": "state", + "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 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", + "type": "string" }, { - "description": "the control nodes count for the Kubernetes cluster", - "name": "controlnodes", + "description": "the size (worker nodes count) of the Kubernetes cluster", + "name": "size", "type": "long" }, { - "description": "the ID of the domain in which the Kubernetes cluster exists", - "name": "domainid", + "description": "the ID of the Kubernetes version for the Kubernetes cluster", + "name": "kubernetesversionid", "type": "string" }, { - "description": "the ID of the template of the Kubernetes cluster", - "name": "templateid", + "description": "the name of the network of the Kubernetes cluster", + "name": "associatednetworkname", "type": "string" } ] @@ -25269,13 +26054,6 @@ "isasync": false, "name": "deleteSSHKeyPair", "params": [ - { - "description": "Name of the keypair", - "length": 255, - "name": "name", - "required": true, - "type": "string" - }, { "description": "the account associated with the keypair. Must be used with the domainId parameter.", "length": 255, @@ -25298,30 +26076,37 @@ "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", "required": false, "type": "uuid" + }, + { + "description": "Name of the keypair", + "length": 255, + "name": "name", + "required": true, + "type": "string" } ], "response": [ + {}, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, - { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - {}, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" + }, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" } ] }, @@ -25331,26 +26116,17 @@ "name": "createAutoScaleVmGroup", "params": [ { - "description": "list of scaledown autoscale policies", + "description": "the frequency at which the conditions have to be evaluated", "length": 255, - "name": "scaledownpolicyids", - "related": "listAutoScalePolicies,updateAutoScalePolicy", - "required": true, - "type": "list" + "name": "interval", + "required": false, + "type": "integer" }, { - "description": "the autoscale profile that contains information about the vms in the vm group.", + "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": "vmprofileid", - "related": "createAutoScaleVmProfile,listAutoScaleVmProfiles,updateAutoScaleVmProfile", + "name": "maxmembers", "required": true, - "type": "uuid" - }, - { - "description": "the frequency at which the conditions have to be evaluated", - "length": 255, - "name": "interval", - "required": false, "type": "integer" }, { @@ -25361,25 +26137,34 @@ "required": true, "type": "list" }, + { + "description": "list of scaledown autoscale policies", + "length": 255, + "name": "scaledownpolicyids", + "related": "listAutoScalePolicies,updateAutoScalePolicy", + "required": true, + "type": "list" + }, { "description": "the ID of the load balancer rule", "length": 255, "name": "lbruleid", - "related": "createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,listIpForwardingRules", + "related": "createIpv6FirewallRule,updateIpv6FirewallRule,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,listIpForwardingRules", "required": true, "type": "uuid" }, { - "description": "the minimum number of members in the vmgroup, the number of instances in the vm group will be equal to or more than this number.", + "description": "the autoscale profile that contains information about the vms in the vm group.", "length": 255, - "name": "minmembers", + "name": "vmprofileid", + "related": "createAutoScaleVmProfile,listAutoScaleVmProfiles,updateAutoScaleVmProfile", "required": true, - "type": "integer" + "type": "uuid" }, { - "description": "the maximum number of members in the vmgroup, The number of instances in the vm group will be equal to or less than this number.", + "description": "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": "maxmembers", + "name": "minmembers", "required": true, "type": "integer" }, @@ -25394,29 +26179,46 @@ ], "related": "disableAutoScaleVmGroup,enableAutoScaleVmGroup,listAutoScaleVmGroups,updateAutoScaleVmGroup", "response": [ + { + "description": "is group for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "the project name of the vm profile", "name": "project", "type": "string" }, { - "description": "is group for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "the domain ID of the vm profile", + "name": "domainid", + "type": "string" + }, + { + "description": "the current state of the AutoScale Vm Group", + "name": "state", + "type": "string" }, { "description": "the autoscale vm group ID", "name": "id", "type": "string" }, + {}, + {}, { - "description": "list of scaleup autoscale policies", - "name": "scaleuppolicies", - "type": "list" + "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 domain name of the vm profile", + "name": "domain", "type": "string" }, { @@ -25424,16 +26226,10 @@ "name": "maxmembers", "type": "int" }, - {}, - { - "description": "the minimum number of members in the vmgroup, the number of instances in the vm group will be equal to or more than this number.", - "name": "minmembers", - "type": "int" - }, { - "description": "list of scaledown autoscale policies", - "name": "scaledownpolicies", - "type": "list" + "description": "the load balancer rule ID", + "name": "lbruleid", + "type": "string" }, { "description": "the project id vm profile", @@ -25441,9 +26237,9 @@ "type": "string" }, { - "description": "the domain name of the vm profile", - "name": "domain", - "type": "string" + "description": "list of scaledown autoscale policies", + "name": "scaledownpolicies", + "type": "list" }, { "description": "the autoscale profile that contains information about the vms in the vm group.", @@ -25451,36 +26247,25 @@ "type": "string" }, { - "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 account owning the instance group", - "name": "account", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the current state of the AutoScale Vm Group", - "name": "state", - "type": "string" + "description": "the minimum number of members in the vmgroup, the number of instances in the vm group will be equal to or more than this number.", + "name": "minmembers", + "type": "int" }, { - "description": "the domain ID of the vm profile", - "name": "domainid", - "type": "string" + "description": "the frequency at which the conditions have to be evaluated", + "name": "interval", + "type": "int" }, { - "description": "the load balancer rule ID", - "name": "lbruleid", - "type": "string" - }, - {} + "description": "list of scaleup autoscale policies", + "name": "scaleuppolicies", + "type": "list" + } ] }, { @@ -25489,12 +26274,11 @@ "name": "searchLdap", "params": [ { - "description": "query to search using", + "description": "", "length": 255, - "name": "query", - "related": "searchLdap,listLdapUsers", - "required": true, - "type": "string" + "name": "page", + "required": false, + "type": "integer" }, { "description": "List by keyword", @@ -25511,33 +26295,35 @@ "type": "integer" }, { - "description": "", + "description": "query to search using", "length": 255, - "name": "page", - "required": false, - "type": "integer" + "name": "query", + "related": "searchLdap,listLdapUsers", + "required": true, + "type": "string" } ], "related": "listLdapUsers", "response": [ { - "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", + "description": "The user's email", + "name": "email", "type": "string" }, + {}, { - "description": "The user's principle", - "name": "principal", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "The user's email", - "name": "email", + "description": "The user's domain", + "name": "domain", "type": "string" }, { @@ -25547,25 +26333,24 @@ }, {}, { - "description": "The user's domain", - "name": "domain", + "description": "The user's principle", + "name": "principal", "type": "string" }, - {}, { - "description": "The user's lastname", - "name": "lastname", + "description": "The user's username", + "name": "username", "type": "string" }, { - "description": "The user's username", - "name": "username", + "description": "The user's lastname", + "name": "lastname", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "The authentication source for this user as known to the system or empty if the user is not yet in cloudstack.", + "name": "conflictingusersource", + "type": "string" } ], "since": "4.2.0" @@ -25579,33 +26364,33 @@ "description": "the ID of the load balancer rule", "length": 255, "name": "id", - "related": "createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,listIpForwardingRules", + "related": "createIpv6FirewallRule,updateIpv6FirewallRule,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,listIpForwardingRules", "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": "any text associated with the success or failure", "name": "displaytext", "type": "string" - }, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" } ] }, @@ -25614,20 +26399,6 @@ "isasync": true, "name": "addBaremetalPxePingServer", "params": [ - { - "description": "URL of the external pxe device", - "length": 255, - "name": "url", - "required": true, - "type": "string" - }, - { - "description": "Tftp root directory of PXE server", - "length": 255, - "name": "tftpdir", - "required": true, - "type": "string" - }, { "description": "PING storage server ip", "length": 255, @@ -25636,19 +26407,12 @@ "type": "string" }, { - "description": "type of pxe device", + "description": "Root directory on PING storage server", "length": 255, - "name": "pxeservertype", + "name": "pingdir", "required": true, "type": "string" }, - { - "description": "Username of PING storage server", - "length": 255, - "name": "pingcifsusername", - "required": false, - "type": "string" - }, { "description": "Pod Id", "length": 255, @@ -25665,12 +26429,25 @@ "type": "string" }, { - "description": "the Physical Network ID", + "description": "Credentials to reach external pxe device", "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork,updatePhysicalNetwork", + "name": "password", "required": true, - "type": "uuid" + "type": "string" + }, + { + "description": "URL of the external pxe device", + "length": 255, + "name": "url", + "required": true, + "type": "string" + }, + { + "description": "Tftp root directory of PXE server", + "length": 255, + "name": "tftpdir", + "required": true, + "type": "string" }, { "description": "Password of PING storage server", @@ -25680,16 +26457,24 @@ "type": "string" }, { - "description": "Root directory on PING storage server", + "description": "Username of PING storage server", "length": 255, - "name": "pingdir", - "required": true, + "name": "pingcifsusername", + "required": false, "type": "string" }, { - "description": "Credentials to reach external pxe device", + "description": "the Physical Network ID", "length": 255, - "name": "password", + "name": "physicalnetworkid", + "related": "createPhysicalNetwork,updatePhysicalNetwork", + "required": true, + "type": "uuid" + }, + { + "description": "type of pxe device", + "length": 255, + "name": "pxeservertype", "required": true, "type": "string" } @@ -25697,18 +26482,13 @@ "related": "", "response": [ { - "description": "PING storage server ip", - "name": "pingstorageserverip", - "type": "string" - }, - { - "description": "Tftp root directory of PXE server", - "name": "tftpdir", + "description": "the physical network to which this external dhcp device belongs to", + "name": "physicalnetworkid", "type": "string" }, { - "description": "the physical network to which this external dhcp device belongs to", - "name": "physicalnetworkid", + "description": "Root directory on PING storage server", + "name": "pingdir", "type": "string" }, { @@ -25717,13 +26497,8 @@ "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "Root directory on PING storage server", - "name": "pingdir", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, {}, @@ -25733,16 +26508,26 @@ "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "PING storage server ip", + "name": "pingstorageserverip", + "type": "string" + }, + { + "description": "Tftp root directory of PXE server", + "name": "tftpdir", "type": "string" }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {}, { "description": "device id of ", "name": "id", "type": "string" - }, - {} + } ] }, { @@ -25751,74 +26536,72 @@ "name": "listPortableIpRanges", "params": [ { - "description": "", + "description": "List by keyword", "length": 255, - "name": "page", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { - "description": "Id of a Region", + "description": "Id of the portable ip range", "length": 255, - "name": "regionid", + "name": "id", + "related": "createPortableIpRange,listPortableIpRanges", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { - "description": "", + "description": "Id of a Region", "length": 255, - "name": "pagesize", + "name": "regionid", "required": false, "type": "integer" }, { - "description": "Id of the portable ip range", + "description": "", "length": 255, - "name": "id", - "related": "createPortableIpRange,listPortableIpRanges", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" } ], "related": "createPortableIpRange", "response": [ - {}, - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the gateway of the VLAN IP range", - "name": "gateway", - "type": "string" - }, { "description": "List of portable IP and association with zone/network/vpc details that are part of GSLB rule", "name": "portableipaddress", "response": [ + { + "description": "State of the ip address. Can be: Allocatin, Allocated and Releasing", + "name": "state", + "type": "string" + }, + { + "description": "the ID of the Network where ip belongs to", + "name": "networkid", + "type": "string" + }, { "description": "the account ID the portable IP address is associated with", "name": "accountid", "type": "string" }, { - "description": "public IP address", - "name": "ipaddress", + "description": "the domain ID the portable IP address is associated with", + "name": "domainid", "type": "string" }, { - "description": "the ID of the zone the public IP address belongs to", - "name": "zoneid", - "type": "string" + "description": "date the portal IP address was acquired", + "name": "allocated", + "type": "date" }, { "description": "VPC the ip belongs to", @@ -25826,72 +26609,74 @@ "type": "string" }, { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", + "description": "public IP address", + "name": "ipaddress", "type": "string" }, { - "description": "the domain ID the portable IP address is associated with", - "name": "domainid", + "description": "the ID of the zone the public IP address belongs to", + "name": "zoneid", "type": "string" }, { - "description": "the ID of the Network where ip belongs to", - "name": "networkid", + "description": "the physical network this belongs to", + "name": "physicalnetworkid", "type": "string" }, { "description": "Region Id in which global load balancer is created", "name": "regionid", "type": "integer" - }, - { - "description": "date the portal IP address was acquired", - "name": "allocated", - "type": "date" - }, - { - "description": "State of the ip address. Can be: Allocatin, Allocated and Releasing", - "name": "state", - "type": "string" } ], "type": "list" }, { - "description": "the start ip of the portable IP range", - "name": "startip", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, { - "description": "the netmask of the VLAN IP range", - "name": "netmask", - "type": "string" + "description": "Region Id in which portable ip range is provisioned", + "name": "regionid", + "type": "integer" }, { - "description": "the ID or VID of the VLAN.", - "name": "vlan", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "Region Id in which portable ip range is provisioned", - "name": "regionid", - "type": "integer" + "description": "the start ip of the portable IP range", + "name": "startip", + "type": "string" }, { "description": "portable IP range ID", "name": "id", "type": "string" }, + { + "description": "the ID or VID of the VLAN.", + "name": "vlan", + "type": "string" + }, + {}, { "description": "the end ip of the portable IP range", "name": "endip", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the netmask of the VLAN IP range", + "name": "netmask", + "type": "string" + }, + { + "description": "the gateway of the VLAN IP range", + "name": "gateway", + "type": "string" } ] }, @@ -25909,8 +26694,76 @@ "type": "uuid" } ], - "related": "", + "related": "", + "response": [ + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {}, + { + "description": "the ID of the virtual machine", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "Base 64 encoded VM user data", + "name": "userdata", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + {} + ], + "since": "4.4" + }, + { + "description": "Updates network permissions.", + "isasync": false, + "name": "createNetworkPermissions", + "params": [ + { + "description": "the network ID", + "length": 255, + "name": "networkid", + "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listSrxFirewallNetworks,listBrocadeVcsDeviceNetworks", + "required": true, + "type": "uuid" + }, + { + "description": "a comma delimited list of account IDs within owner's domain. If specified, \"op\" parameter has to be passed in.", + "length": 255, + "name": "accountids", + "related": "createAccount,disableAccount,enableAccount,updateAccount,markDefaultZoneForAccount,listAccounts,listAccounts", + "required": false, + "type": "list" + }, + { + "description": "a comma delimited list of accounts within owner's domain. If specified, \"op\" parameter has to be passed in.", + "length": 255, + "name": "accounts", + "required": false, + "type": "list" + }, + { + "description": "a comma delimited list of projects within owner's domain. If specified, \"op\" parameter has to be passed in.", + "length": 255, + "name": "projectids", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "required": false, + "type": "list" + } + ], "response": [ + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, {}, { "description": "the UUID of the latest async job acting on this object", @@ -25918,23 +26771,18 @@ "type": "string" }, { - "description": "the ID of the virtual machine", - "name": "virtualmachineid", - "type": "string" - }, - { - "description": "Base 64 encoded VM user data", - "name": "userdata", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, {} ], - "since": "4.4" + "since": "4.17.0" }, { "description": "Lists all configurations.", @@ -25942,18 +26790,34 @@ "name": "listConfigurations", "params": [ { - "description": "lists configuration by name", + "description": "List by keyword", "length": 255, - "name": "name", + "name": "keyword", "required": false, "type": "string" }, { - "description": "", + "description": "the ID of the Account to update the parameter value for corresponding account", "length": 255, - "name": "pagesize", + "name": "accountid", + "related": "createAccount,disableAccount,enableAccount,updateAccount,markDefaultZoneForAccount,listAccounts,listAccounts", "required": false, - "type": "integer" + "type": "uuid" + }, + { + "description": "the ID of the Image Store to update the parameter value for corresponding image store", + "length": 255, + "name": "imagestoreuuid", + "related": "addSecondaryStorage,listSwifts,updateImageStore,addImageStore,addImageStoreS3,listImageStores,updateCloudToUseObjectStore", + "required": false, + "type": "uuid" + }, + { + "description": "lists configuration by name", + "length": 255, + "name": "name", + "required": false, + "type": "string" }, { "description": "lists configurations by category", @@ -25971,10 +26835,10 @@ "type": "uuid" }, { - "description": "the ID of the Zone to update the parameter value for corresponding zone", + "description": "the ID of the Storage pool to update the parameter value for corresponding storage pool", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "storageid", + "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities", "required": false, "type": "uuid" }, @@ -25987,80 +26851,65 @@ "type": "uuid" }, { - "description": "the ID of the Image Store to update the parameter value for corresponding image store", - "length": 255, - "name": "imagestoreuuid", - "related": "addSecondaryStorage,listSwifts,updateImageStore,addImageStore,addImageStoreS3,listImageStores,updateCloudToUseObjectStore", - "required": false, - "type": "uuid" - }, - { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { - "description": "the ID of the Account to update the parameter value for corresponding account", + "description": "", "length": 255, - "name": "accountid", - "related": "createAccount,disableAccount,enableAccount,updateAccount,markDefaultZoneForAccount,listAccounts,listAccounts", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "the ID of the Storage pool to update the parameter value for corresponding storage pool", + "description": "the ID of the Zone to update the parameter value for corresponding zone", "length": 255, - "name": "storageid", - "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, "type": "uuid" - }, - { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" } ], "related": "updateConfiguration", "response": [ { - "description": "true if the configuration is dynamic", - "name": "isdynamic", - "type": "boolean" + "description": "the description of the configuration", + "name": "description", + "type": "string" }, + {}, { "description": "the value of the configuration", "name": "id", "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 category of the configuration", - "name": "category", + "description": "the UUID of the latest async job acting on 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 configuration", + "name": "name", + "type": "string" }, { - "description": "scope(zone/cluster/pool/account) of the parameter that needs to be updated", - "name": "scope", - "type": "string" + "description": "true if the configuration is dynamic", + "name": "isdynamic", + "type": "boolean" }, { - "description": "the description of the configuration", - "name": "description", + "description": "the category of the configuration", + "name": "category", "type": "string" }, { @@ -26068,10 +26917,9 @@ "name": "value", "type": "string" }, - {}, { - "description": "the name of the configuration", - "name": "name", + "description": "scope(zone/cluster/pool/account) of the parameter that needs to be updated", + "name": "scope", "type": "string" } ] @@ -26091,27 +26939,27 @@ } ], "response": [ + {}, {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, - {}, { "description": "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" } ] }, @@ -26120,13 +26968,6 @@ "isasync": true, "name": "addIpToNic", "params": [ - { - "description": "Secondary IP Address", - "length": 255, - "name": "ipaddress", - "required": false, - "type": "string" - }, { "description": "the ID of the nic to which you want to assign private IP", "length": 255, @@ -26134,6 +26975,13 @@ "related": "listNics", "required": true, "type": "uuid" + }, + { + "description": "Secondary IP Address", + "length": 255, + "name": "ipaddress", + "required": false, + "type": "string" } ], "related": "", @@ -26144,20 +26992,14 @@ "name": "networkid", "type": "string" }, - {}, - { - "description": "the ID of the nic", - "name": "nicid", - "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": "Secondary IP address", + "name": "ipaddress", "type": "string" }, { @@ -26166,8 +27008,8 @@ "type": "string" }, { - "description": "Secondary IP address", - "name": "ipaddress", + "description": "the ID of the nic", + "name": "nicid", "type": "string" }, { @@ -26175,6 +27017,12 @@ "name": "secondaryip", "type": "list" }, + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, { "description": "the ID of the vm", "name": "virtualmachineid", @@ -26187,6 +27035,14 @@ "isasync": true, "name": "scaleKubernetesCluster", "params": [ + { + "description": "the ID of the Kubernetes cluster", + "length": 255, + "name": "id", + "related": "createKubernetesCluster,startKubernetesCluster,scaleKubernetesCluster,upgradeKubernetesCluster", + "required": true, + "type": "uuid" + }, { "description": "the IDs of the nodes to be removed", "length": 255, @@ -26196,18 +27052,19 @@ "type": "list" }, { - "description": "Minimum number of worker nodes in the cluster", + "description": "number of Kubernetes cluster nodes", "length": 255, - "name": "minsize", + "name": "size", "required": false, "type": "long" }, { - "description": "number of Kubernetes cluster nodes", + "description": "the ID of the service offering for the virtual machines in the cluster.", "length": 255, - "name": "size", + "name": "serviceofferingid", + "related": "createServiceOffering,updateServiceOffering,listServiceOfferings", "required": false, - "type": "long" + "type": "uuid" }, { "description": "Maximum number of worker nodes in the cluster", @@ -26216,14 +27073,6 @@ "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": "Whether autoscaling is enabled for the cluster", "length": 255, @@ -26232,29 +27081,33 @@ "type": "boolean" }, { - "description": "the ID of the Kubernetes cluster", + "description": "Minimum number of worker nodes in the cluster", "length": 255, - "name": "id", - "related": "createKubernetesCluster,startKubernetesCluster,scaleKubernetesCluster,upgradeKubernetesCluster", - "required": true, - "type": "uuid" + "name": "minsize", + "required": false, + "type": "long" } ], "related": "createKubernetesCluster,startKubernetesCluster,upgradeKubernetesCluster", "response": [ { - "description": "the name of the Kubernetes cluster", - "name": "name", + "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", + "description": "the size (worker nodes count) of the Kubernetes cluster", + "name": "size", + "type": "long" + }, + { + "description": "the project name of the Kubernetes cluster", + "name": "project", "type": "string" }, { - "description": "keypair details", - "name": "keypair", + "description": "the ID of the service offering of the Kubernetes cluster", + "name": "serviceofferingid", "type": "string" }, { @@ -26262,9 +27115,60 @@ "name": "associatednetworkname", "type": "string" }, + {}, { - "description": "the project id of the Kubernetes cluster", - "name": "projectid", + "description": "the master nodes count for the Kubernetes cluster. This parameter is deprecated, please use 'controlnodes' parameter.", + "name": "masternodes", + "type": "long" + }, + { + "description": "URL end point for the Kubernetes cluster", + "name": "endpoint", + "type": "string" + }, + { + "description": "the name of the zone of the Kubernetes cluster", + "name": "zoneid", + "type": "string" + }, + { + "description": "the name of the service offering of the Kubernetes cluster", + "name": "serviceofferingname", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the list of virtualmachine associated with this Kubernetes cluster", + "name": "virtualmachines", + "type": "list" + }, + { + "description": "the name of the domain in which the Kubernetes cluster exists", + "name": "domain", + "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the cpu cores of the Kubernetes cluster", + "name": "cpunumber", + "type": "string" + }, + { + "description": "the id of the Kubernetes cluster", + "name": "id", + "type": "string" + }, + { + "description": "Public IP Address ID of the cluster", + "name": "ipaddressid", "type": "string" }, { @@ -26273,181 +27177,373 @@ "type": "string" }, { - "description": "the account associated with the Kubernetes cluster", - "name": "account", + "description": "the project id of the Kubernetes cluster", + "name": "projectid", "type": "string" }, { - "description": "URL end point for the Kubernetes cluster dashboard UI", - "name": "consoleendpoint", + "description": "the description of the Kubernetes cluster", + "name": "description", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the name of the Kubernetes version for the Kubernetes cluster", + "name": "kubernetesversionname", + "type": "string" }, { - "description": "the size (worker nodes count) of the Kubernetes cluster", - "name": "size", - "type": "long" + "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": "Whether autoscaling is enabled for the cluster", + "name": "autoscalingenabled", + "type": "boolean" + }, + { + "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 name of the Kubernetes cluster", + "name": "name", + "type": "string" }, { "description": "the ID of the Kubernetes version for the Kubernetes cluster", "name": "kubernetesversionid", "type": "string" }, + { + "description": "the control nodes count for the Kubernetes cluster", + "name": "controlnodes", + "type": "long" + }, { "description": "Minimum size of the cluster", "name": "minsize", "type": "long" }, { - "description": "the name of the domain in which the Kubernetes cluster exists", - "name": "domain", + "description": "the ID of the domain in which the Kubernetes cluster exists", + "name": "domainid", "type": "string" }, + { + "description": "the date when this Kubernetes cluster was created", + "name": "created", + "type": "date" + }, { "description": "Maximum size of the cluster", "name": "maxsize", "type": "long" }, { - "description": "the master nodes count for the Kubernetes cluster. This parameter is deprecated, please use 'controlnodes' parameter.", - "name": "masternodes", - "type": "long" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, - {}, { - "description": "the control nodes count for the Kubernetes cluster", - "name": "controlnodes", - "type": "long" + "description": "keypair details", + "name": "keypair", + "type": "string" + }, + { + "description": "the memory the Kubernetes cluster", + "name": "memory", + "type": "string" + }, + { + "description": "the ID of the template of the Kubernetes cluster", + "name": "templateid", + "type": "string" + } + ] + }, + { + "description": "Stops a NetScalervm.", + "isasync": true, + "name": "stopNetScalerVpx", + "params": [ + { + "description": "Force stop the VM. The caller knows the VM is stopped.", + "length": 255, + "name": "forced", + "required": false, + "type": "boolean" + }, + { + "description": "the ID of the NetScaler vm", + "length": 255, + "name": "id", + "related": "destroyRouter,listRouters,rebootRouter,changeServiceForRouter,stopInternalLoadBalancerVM,listInternalLoadBalancerVMs,stopNetScalerVpx", + "required": true, + "type": "uuid" + } + ], + "related": "destroyRouter,listRouters,rebootRouter,changeServiceForRouter,stopInternalLoadBalancerVM,listInternalLoadBalancerVMs", + "response": [ + { + "description": "the hostname for the router", + "name": "hostname", + "type": "string" + }, + { + "description": "the list of nics associated with the router", + "name": "nic", + "response": [ + { + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" + }, + { + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", + "type": "string" + }, + { + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "macaddress", + "type": "string" + }, + { + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "the ID of the corresponding network", + "name": "networkid", + "type": "string" + }, + { + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", + "type": "string" + }, + { + "description": "the gateway of the nic", + "name": "gateway", + "type": "string" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" + }, + { + "description": "the netmask of the nic", + "name": "netmask", + "type": "string" + }, + { + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "the name of the corresponding network", + "name": "networkname", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", + "type": "string" + }, + { + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", + "type": "string" + }, + { + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" + }, + { + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", + "type": "string" + }, + { + "description": "the broadcast uri of the nic", + "name": "broadcasturi", + "type": "string" + }, + { + "description": "the traffic type of the nic", + "name": "traffictype", + "type": "string" + }, + { + "description": "the IPv6 address of network", + "name": "ip6address", + "type": "string" + }, + { + "description": "the ID of the nic", + "name": "id", + "type": "string" + }, + { + "description": "the isolation uri of the nic", + "name": "isolationuri", + "type": "string" + }, + { + "description": "the type of the nic", + "name": "type", + "type": "string" + }, + { + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + }, + { + "description": "the ip address of the nic", + "name": "ipaddress", + "type": "string" + } + ], + "type": "set" }, { - "description": "the ID of the domain in which the Kubernetes cluster exists", - "name": "domainid", + "description": "the version of scripts", + "name": "scriptsversion", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the id of the Kubernetes cluster", + "description": "the id of the router", "name": "id", "type": "string" }, { - "description": "the ID of the template of the Kubernetes cluster", - "name": "templateid", + "description": "the guest IP address for the router", + "name": "guestipaddress", "type": "string" }, { - "description": "URL end point for the Kubernetes cluster", - "name": "endpoint", + "description": "the host ID for the router", + "name": "hostid", "type": "string" }, { - "description": "the name of the Kubernetes version for the Kubernetes cluster", - "name": "kubernetesversionname", - "type": "string" + "description": "true if any health checks had failed", + "name": "healthchecksfailed", + "type": "boolean" }, { - "description": "the description of the Kubernetes cluster", - "name": "description", + "description": "the Zone name for the router", + "name": "zonename", "type": "string" }, { - "description": "the name of the service offering of the Kubernetes cluster", - "name": "serviceofferingname", + "description": "the ID of the corresponding public network", + "name": "publicnetworkid", "type": "string" }, { - "description": "the project name of the Kubernetes cluster", - "name": "project", + "description": "the version of template", + "name": "version", "type": "string" }, { - "description": "the ID of the network of the Kubernetes cluster", - "name": "networkid", + "description": "the state of redundant virtual router", + "name": "redundantstate", "type": "string" }, { - "description": "the list of virtualmachine associated with this Kubernetes cluster", - "name": "virtualmachines", - "type": "list" - }, - {}, - { - "description": "the ID of the service offering of the Kubernetes cluster", + "description": "the ID of the service offering of the virtual machine", "name": "serviceofferingid", "type": "string" }, { - "description": "the state of the Kubernetes cluster", + "description": "the state of the router", "name": "state", - "type": "string" + "type": "state" }, { - "description": "Public IP Address ID of the cluster", - "name": "ipaddressid", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "Whether autoscaling is enabled for the cluster", - "name": "autoscalingenabled", - "type": "boolean" + "description": "the guest netmask for the router", + "name": "guestnetmask", + "type": "string" }, { - "description": "the memory the Kubernetes cluster", - "name": "memory", + "description": "the name of VPC the router belongs to", + "name": "vpcname", "type": "string" }, { - "description": "the cpu cores of the Kubernetes cluster", - "name": "cpunumber", + "description": "the link local MAC address for the router", + "name": "linklocalmacaddress", "type": "string" }, { - "description": "the name of the zone of the Kubernetes cluster", - "name": "zoneid", + "description": "the ID of the corresponding link local network", + "name": "linklocalnetworkid", "type": "string" }, + {}, { - "description": "the name of the zone of the Kubernetes cluster", - "name": "zonename", + "description": "the template name for the router", + "name": "templatename", "type": "string" - } - ] - }, - { - "description": "Stops a NetScalervm.", - "isasync": true, - "name": "stopNetScalerVpx", - "params": [ - { - "description": "the ID of the NetScaler vm", - "length": 255, - "name": "id", - "related": "destroyRouter,listRouters,rebootRouter,changeServiceForRouter,stopInternalLoadBalancerVM,listInternalLoadBalancerVMs,stopNetScalerVpx", - "required": true, - "type": "uuid" }, { - "description": "Force stop the VM. The caller knows the VM is stopped.", - "length": 255, - "name": "forced", - "required": false, + "description": "if this router is an redundant virtual router", + "name": "isredundantrouter", "type": "boolean" - } - ], - "related": "destroyRouter,listRouters,rebootRouter,changeServiceForRouter,stopInternalLoadBalancerVM,listInternalLoadBalancerVMs", - "response": [ + }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the version of the code / software in the router", + "name": "softwareversion", + "type": "string" }, { "description": "role of the domain router", @@ -26455,78 +27551,79 @@ "type": "string" }, { - "description": "the ID of the corresponding public network", - "name": "publicnetworkid", + "description": "the name of the corresponding guest network", + "name": "guestnetworkname", "type": "string" }, { - "description": "the template name for the router", - "name": "templatename", + "description": "the ID of the corresponding guest network", + "name": "guestnetworkid", "type": "string" }, { - "description": "the Pod name for the router", - "name": "podname", + "description": "the second DNS for the router", + "name": "dns2", "type": "string" }, { - "description": "the name of the corresponding guest network", - "name": "guestnetworkname", + "description": "the Zone ID for the router", + "name": "zoneid", "type": "string" }, { - "description": "the ID of the corresponding guest network", - "name": "guestnetworkid", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the first DNS for the router", - "name": "dns1", + "description": "the name of the router", + "name": "name", "type": "string" }, + {}, { - "description": "the link local MAC address for the router", - "name": "linklocalmacaddress", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the id of the router", - "name": "id", - "type": "string" + "description": "true if the router template requires upgrader", + "name": "requiresupgrade", + "type": "boolean" }, { - "description": "the guest MAC address for the router", - "name": "guestmacaddress", + "description": "the public netmask for the router", + "name": "publicnetmask", "type": "string" }, { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "the first DNS for the router", + "name": "dns1", "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": "the name of the health check on the router", - "name": "checkname", - "type": "string" + "description": "result of the health check", + "name": "success", + "type": "boolean" }, { "description": "detailed response generated on running health check", @@ -26537,103 +27634,73 @@ "type": "list" }, { - "description": "the account associated with the router", - "name": "account", - "type": "string" - }, - { - "description": "VPC the router belongs to", - "name": "vpcid", - "type": "string" - }, - { - "description": "the Pod ID for the router", - "name": "podid", - "type": "string" - }, - { - "description": "the version of template", - "name": "version", + "description": "the link local netmask for the router", + "name": "linklocalnetmask", "type": "string" }, { - "description": "the template ID for the router", - "name": "templateid", + "description": "the domain associated with the router", + "name": "domain", "type": "string" }, { - "description": "the host ID for the router", - "name": "hostid", + "description": "the first IPv6 DNS for the router", + "name": "ip6dns1", "type": "string" }, { - "description": "the name of the router", - "name": "name", + "description": "the gateway for the router", + "name": "gateway", "type": "string" }, { - "description": "true if the router template requires upgrader", - "name": "requiresupgrade", - "type": "boolean" - }, - { - "description": "the ID of the corresponding link local network", - "name": "linklocalnetworkid", + "description": "the network domain for the router", + "name": "networkdomain", "type": "string" }, { - "description": "the guest IP address for the router", - "name": "guestipaddress", + "description": "VPC the router belongs to", + "name": "vpcid", "type": "string" }, { - "description": "the version of scripts", - "name": "scriptsversion", + "description": "the second IPv6 DNS for the router", + "name": "ip6dns2", "type": "string" }, { - "description": "the link local netmask for the router", - "name": "linklocalnetmask", + "description": "the account associated with the router", + "name": "account", "type": "string" }, { - "description": "the name of VPC the router belongs to", - "name": "vpcname", + "description": "the guest MAC address for the router", + "name": "guestmacaddress", "type": "string" }, - { - "description": "true if any health checks had failed", - "name": "healthchecksfailed", - "type": "boolean" - }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, { - "description": "the domain ID associated with the router", - "name": "domainid", + "description": "the public MAC address for the router", + "name": "publicmacaddress", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the guest netmask for the router", - "name": "guestnetmask", + "description": "the project id of the ipaddress", + "name": "projectid", "type": "string" }, { - "description": "the gateway for the router", - "name": "gateway", + "description": "the domain ID associated with the router", + "name": "domainid", "type": "string" }, { @@ -26641,234 +27708,35 @@ "name": "publicip", "type": "string" }, - { - "description": "the date and time the router was created", - "name": "created", - "type": "date" - }, - { - "description": "the network domain for the router", - "name": "networkdomain", - "type": "string" - }, { "description": "the link local IP address for the router", "name": "linklocalip", "type": "string" }, { - "description": "the state of the router", - "name": "state", - "type": "state" + "description": "the Pod ID for the router", + "name": "podid", + "type": "string" }, { - "description": "the Zone name for the router", - "name": "zonename", + "description": "the Pod name for the router", + "name": "podname", "type": "string" }, { - "description": "the domain associated with the router", - "name": "domain", - "type": "string" + "description": "the date and time the router was created", + "name": "created", + "type": "date" }, - {}, { "description": "the project name of the address", "name": "project", "type": "string" }, { - "description": "the public netmask for the router", - "name": "publicnetmask", - "type": "string" - }, - { - "description": "the second DNS for the router", - "name": "dns2", - "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 second IPv6 DNS for the router", - "name": "ip6dns2", - "type": "string" - }, - {}, - { - "description": "the first IPv6 DNS for the router", - "name": "ip6dns1", - "type": "string" - }, - { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", - "type": "string" - }, - { - "description": "the public MAC address for the router", - "name": "publicmacaddress", - "type": "string" - }, - { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", - "type": "string" - }, - { - "description": "if this router is an redundant virtual router", - "name": "isredundantrouter", - "type": "boolean" - }, - { - "description": "the Zone ID for the router", - "name": "zoneid", - "type": "string" - }, - { - "description": "the list of nics associated with the router", - "name": "nic", - "response": [ - { - "description": "the netmask of the nic", - "name": "netmask", - "type": "string" - }, - { - "description": "the ip address of the nic", - "name": "ipaddress", - "type": "string" - }, - { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", - "type": "string" - }, - { - "description": "the ID of the corresponding network", - "name": "networkid", - "type": "string" - }, - { - "description": "the isolation uri of the nic", - "name": "isolationuri", - "type": "string" - }, - { - "description": "the type of the nic", - "name": "type", - "type": "string" - }, - { - "description": "true if nic is default, false otherwise", - "name": "macaddress", - "type": "string" - }, - { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" - }, - { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", - "type": "string" - }, - { - "description": "the IPv6 address of network", - "name": "ip6address", - "type": "string" - }, - { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", - "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 traffic type of the nic", - "name": "traffictype", - "type": "string" - }, - { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" - }, - { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "the 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": "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 cidr of IPv6 network", - "name": "ip6cidr", - "type": "string" - }, - { - "description": "the gateway of the nic", - "name": "gateway", - "type": "string" - }, - { - "description": "the ID of the nic", - "name": "id", - "type": "string" - }, - { - "description": "Type of adapter if available", - "name": "adaptertype", - "type": "string" - }, - { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - }, - { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", - "type": "string" - } - ], - "type": "set" + "description": "the template ID for the router", + "name": "templateid", + "type": "string" } ] }, @@ -26892,6 +27760,12 @@ "name": "jobid", "type": "string" }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {}, {}, { "description": "true if operation is executed successfully", @@ -26902,13 +27776,7 @@ "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" - }, - {} + } ] }, { @@ -26917,9 +27785,9 @@ "name": "deleteHost", "params": [ { - "description": "Force destroy local storage on this host. All VMs created on this local storage will be destroyed", + "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": "forcedestroylocalstorage", + "name": "forced", "required": false, "type": "boolean" }, @@ -26927,19 +27795,30 @@ "description": "the host ID", "length": 255, "name": "id", - "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost,addBaremetalHost,listExternalLoadBalancers", + "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", + "description": "Force destroy local storage on this host. All VMs created on this local storage will be destroyed", "length": 255, - "name": "forced", + "name": "forcedestroylocalstorage", "required": false, "type": "boolean" } ], "response": [ + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + }, + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, { "description": "true if operation is executed successfully", "name": "success", @@ -26950,18 +27829,7 @@ "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" - } + {} ] }, { @@ -26984,6 +27852,11 @@ "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", @@ -26995,11 +27868,6 @@ "name": "displaytext", "type": "string" }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, {} ] }, @@ -27009,43 +27877,43 @@ "name": "deleteResourceIcon", "params": [ { - "description": "type of the resource", + "description": "list of resources to upload the icon/image for", "length": 255, - "name": "resourcetype", + "name": "resourceids", "required": true, - "type": "string" + "type": "list" }, { - "description": "list of resources to upload the icon/image for", + "description": "type of the resource", "length": 255, - "name": "resourceids", + "name": "resourcetype", "required": true, - "type": "list" + "type": "string" } ], "response": [ - {}, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - } + {}, + {} ], "since": "4.16.0.0" }, @@ -27057,8 +27925,13 @@ "related": "", "response": [ { - "description": "true if region wide secondary is enabled, false otherwise", - "name": "regionsecondaryenabled", + "description": "true if snapshot is supported for KVM host, false otherwise", + "name": "kvmsnapshotenabled", + "type": "boolean" + }, + { + "description": "true if experimental features for Kubernetes cluster such as Docker private registry are enabled, false otherwise", + "name": "kubernetesclusterexperimentalfeaturesenabled", "type": "boolean" }, { @@ -27067,9 +27940,9 @@ "type": "boolean" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "default page size in the UI for various views, value set in the configurations", + "name": "defaultuipagesize", + "type": "long" }, { "description": "true if the user can recover and expunge volumes, false otherwise", @@ -27081,94 +27954,195 @@ "name": "customdiskofferingminsize", "type": "long" }, + {}, { - "description": "true if region supports elastic load balancer on basic zones", - "name": "supportELB", - "type": "string" + "description": "Max allowed number of api requests within the specified interval", + "name": "apilimitmax", + "type": "integer" }, { - "description": "true if user and domain admins can set templates to be shared, false otherwise", - "name": "userpublictemplateenabled", + "description": "true if Kubernetes Service plugin is enabled, false otherwise", + "name": "kubernetesserviceenabled", "type": "boolean" }, { - "description": "If invitation confirmation is required when add account to project", - "name": "projectinviterequired", + "description": "true if region wide secondary is enabled, false otherwise", + "name": "regionsecondaryenabled", "type": "boolean" }, - { - "description": "Max allowed number of api requests within the specified interval", - "name": "apilimitmax", - "type": "integer" - }, - {}, { "description": "time interval (in seconds) to reset api count", "name": "apilimitinterval", "type": "integer" }, { - "description": "true if dynamic role-based api checker is enabled, false otherwise", - "name": "dynamicrolesenabled", + "description": "true if the user is allowed to view destroyed virtualmachines, false otherwise", + "name": "allowuserviewdestroyedvm", "type": "boolean" }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "version of the cloud stack", "name": "cloudstackversion", "type": "string" }, { - "description": "true if snapshot is supported for KVM host, false otherwise", - "name": "kvmsnapshotenabled", - "type": "boolean" + "description": "maximum size that can be specified when create disk from disk offering with custom size", + "name": "customdiskofferingmaxsize", + "type": "long" }, { - "description": "true if experimental features for Kubernetes cluster such as Docker private registry are enabled, false otherwise", - "name": "kubernetesclusterexperimentalfeaturesenabled", - "type": "boolean" + "description": "true if region supports elastic load balancer on basic zones", + "name": "supportELB", + "type": "string" }, { - "description": "true if users can see all accounts within the same domain, false otherwise", - "name": "allowuserviewalldomainaccounts", + "description": "If invitation confirmation is required when add account to project", + "name": "projectinviterequired", "type": "boolean" }, - {}, { - "description": "true if Kubernetes Service plugin is enabled, false otherwise", - "name": "kubernetesserviceenabled", + "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": "true if the user can recover and expunge virtualmachines, false otherwise", "name": "allowuserexpungerecovervm", "type": "boolean" }, { - "description": "true if the user is allowed to view destroyed virtualmachines, false otherwise", - "name": "allowuserviewdestroyedvm", + "description": "true if user and domain admins can set templates to be shared, false otherwise", + "name": "userpublictemplateenabled", "type": "boolean" }, { - "description": "maximum size that can be specified when create disk from disk offering with custom size", - "name": "customdiskofferingmaxsize", - "type": "long" + "description": "true if users can see all accounts within the same domain, false otherwise", + "name": "allowuserviewalldomainaccounts", + "type": "boolean" }, { - "description": "default page size in the UI for various views, value set in the configurations", - "name": "defaultuipagesize", - "type": "long" + "description": "true if dynamic role-based api checker is enabled, false otherwise", + "name": "dynamicrolesenabled", + "type": "boolean" + }, + {} + ] + }, + { + "description": "Updates traffic type of a physical network", + "isasync": true, + "name": "updateTrafficType", + "params": [ + { + "description": "The network name label of the physical device dedicated to this traffic on a Hyperv host", + "length": 255, + "name": "hypervnetworklabel", + "required": false, + "type": "string" + }, + { + "description": "The network name label of the physical device dedicated to this traffic on a KVM host", + "length": 255, + "name": "kvmnetworklabel", + "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 network name label of the physical device dedicated to this traffic on a VMware host", + "length": 255, + "name": "vmwarenetworklabel", + "required": false, + "type": "string" }, + { + "description": "The network name label of the physical device dedicated to this traffic on a XenServer host", + "length": 255, + "name": "xennetworklabel", + "required": false, + "type": "string" + }, + { + "description": "traffic type id", + "length": 255, + "name": "id", + "related": "addTrafficType,updateTrafficType", + "required": true, + "type": "uuid" + } + ], + "related": "addTrafficType", + "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 network name of the physical device dedicated to this traffic on an OVM3 host", + "name": "ovm3networklabel", + "type": "string" + }, + { + "description": "the trafficType to be added to the physical network", + "name": "traffictype", + "type": "string" + }, + { + "description": "The network name label of the physical device dedicated to this traffic on a HyperV host", + "name": "hypervnetworklabel", + "type": "string" + }, + { + "description": "id of the network provider", + "name": "id", + "type": "string" + }, + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "The network name label of the physical device dedicated to this traffic on a VMware host", + "name": "vmwarenetworklabel", + "type": "string" + }, + {}, + { + "description": "the physical network this belongs to", + "name": "physicalnetworkid", + "type": "string" + }, + { + "description": "The network name label of the physical device dedicated to this traffic on a XenServer host", + "name": "xennetworklabel", + "type": "string" + }, + { + "description": "The network name label of the physical device dedicated to this traffic on a KVM host", + "name": "kvmnetworklabel", + "type": "string" } - ] + ], + "since": "3.0.0" }, { "description": "Release dedication of zone", @@ -27185,11 +28159,18 @@ } ], "response": [ + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" }, + {}, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", @@ -27199,91 +28180,126 @@ "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": "Updates traffic type of a physical network", - "isasync": true, - "name": "updateTrafficType", + "description": "List Conditions for the specific user", + "isasync": false, + "name": "listConditions", "params": [ { - "description": "The network name label of the physical device dedicated to this traffic on a Hyperv host", + "description": "Counter-id of the condition.", "length": 255, - "name": "hypervnetworklabel", + "name": "counterid", + "related": "createCounter,listCounters", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "The network name label of the physical device dedicated to this traffic on a VMware host", + "description": "List by keyword", "length": 255, - "name": "vmwarenetworklabel", + "name": "keyword", "required": false, "type": "string" }, { - "description": "The network name of the physical device dedicated to this traffic on an OVM3 host", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "ovm3networklabel", + "name": "listall", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "traffic type id", + "description": "ID of the Condition.", "length": 255, "name": "id", - "related": "addTrafficType,updateTrafficType", - "required": true, + "related": "createCondition,listConditions", + "required": false, "type": "uuid" }, { - "description": "The network name label of the physical device dedicated to this traffic on a XenServer host", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "xennetworklabel", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "The network name label of the physical device dedicated to this traffic on a KVM host", + "description": "the ID of the policy", "length": 255, - "name": "kvmnetworklabel", + "name": "policyid", + "related": "listAutoScalePolicies,updateAutoScalePolicy", + "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": "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", + "required": false, + "type": "integer" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" } ], - "related": "addTrafficType", + "related": "createCondition", "response": [ - {}, { - "description": "The network name of the physical device dedicated to this traffic on an OVM3 host", - "name": "ovm3networklabel", + "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 project name of the Condition", + "name": "project", + "type": "string" }, + {}, { - "description": "The network name label of the physical device dedicated to this traffic on a VMware host", - "name": "vmwarenetworklabel", + "description": "Threshold Value for the counter.", + "name": "threshold", + "type": "long" + }, + { + "description": "the domain name of the owner.", + "name": "domain", "type": "string" }, { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", + "description": "Relational Operator to be used with threshold.", + "name": "relationaloperator", "type": "string" }, + {}, { - "description": "The network name label of the physical device dedicated to this traffic on a XenServer host", - "name": "xennetworklabel", + "description": "the project id of the Condition.", + "name": "projectid", + "type": "string" + }, + { + "description": "zone id of counter", + "name": "zoneid", "type": "string" }, { @@ -27292,213 +28308,283 @@ "type": "string" }, { - "description": "id of the network provider", + "description": "the id of the Condition", "name": "id", "type": "string" }, - {}, { - "description": "the trafficType to be added to the physical network", - "name": "traffictype", + "description": "the domain id of the Condition owner", + "name": "domainid", "type": "string" }, { - "description": "The network name label of the physical device dedicated to this traffic on a HyperV host", - "name": "hypervnetworklabel", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "The network name label of the physical device dedicated to this traffic on a KVM host", - "name": "kvmnetworklabel", - "type": "string" + "description": "Details of the Counter.", + "name": "counter", + "type": "list" } - ], - "since": "3.0.0" + ] }, { - "description": "List Conditions for the specific user", - "isasync": false, - "name": "listConditions", + "description": "Updates a network serviceProvider of a physical network", + "isasync": true, + "name": "updateNetworkServiceProvider", "params": [ { - "description": "ID of the Condition.", + "description": "Enabled/Disabled/Shutdown the physical network service provider", "length": 255, - "name": "id", - "related": "createCondition,listConditions", + "name": "state", "required": false, + "type": "string" + }, + { + "description": "network service provider id", + "length": 255, + "name": "id", + "related": "addNetworkServiceProvider,listNetworkServiceProviders,updateNetworkServiceProvider,listTrafficTypes", + "required": true, "type": "uuid" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "the list of services to be enabled for this physical network service provider", "length": 255, - "name": "isrecursive", + "name": "servicelist", "required": false, + "type": "list" + } + ], + "related": "addNetworkServiceProvider,listNetworkServiceProviders,listTrafficTypes", + "response": [ + { + "description": "the physical network this belongs to", + "name": "physicalnetworkid", + "type": "string" + }, + { + "description": "the provider name", + "name": "name", + "type": "string" + }, + { + "description": "the destination physical network", + "name": "destinationphysicalnetworkid", + "type": "string" + }, + {}, + { + "description": "true if individual services can be enabled/disabled", + "name": "canenableindividualservice", "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": "uuid of the network provider", + "name": "id", + "type": "string" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "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": "state of the network provider", + "name": "state", "type": "string" }, { - "description": "the ID of the policy", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + } + ], + "since": "3.0.0" + }, + { + "description": "Lists Management Server metrics", + "isasync": false, + "name": "listManagementServersMetrics", + "params": [ + { + "description": "include system level stats", "length": 255, - "name": "policyid", - "related": "listAutoScalePolicies,updateAutoScalePolicy", + "name": "system", + "related": "listManagementServersMetrics", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "Counter-id of the condition.", + "description": "", "length": 255, - "name": "counterid", - "related": "createCounter,listCounters", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "", + "description": "the id of the management server", "length": 255, - "name": "page", + "name": "id", + "related": "listManagementServers", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "", + "description": "the name of the management server", "length": 255, - "name": "pagesize", + "name": "name", "required": false, - "type": "integer" + "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" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false", + "description": "", "length": 255, - "name": "listall", + "name": "pagesize", "required": false, - "type": "boolean" + "type": "integer" } ], - "related": "createCondition", + "related": "", "response": [ { - "description": "the domain name of the owner.", - "name": "domain", - "type": "string" + "description": "The number of terminated threads", + "name": "threadsteminatedcount", + "type": "integer" }, { - "description": "the owner of the Condition.", - "name": "account", + "description": "the amount of memory allocated to this Management Server", + "name": "heapmemorytotal", + "type": "long" + }, + { + "description": "the java distribution name running the management server process", + "name": "javadistribution", "type": "string" }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the load averages for 1 5 and 15 minutes", + "name": "systemloadaverages", + "type": "double[]" + }, {}, { - "description": "the domain id of the Condition owner", - "name": "domainid", - "type": "string" + "description": "The number of threads", + "name": "threadstotalcount", + "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "The number of blocked threads", + "name": "threadsblockedcount", + "type": "integer" }, { - "description": "Threshold Value for the counter.", - "name": "threshold", - "type": "long" + "description": "The number of runnable threads", + "name": "threadsrunnablecount", + "type": "integer" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "the number of agents this Management Server is responsible for", + "name": "agentcount", "type": "integer" }, { - "description": "the id of the Condition", + "description": "the name of the management server", + "name": "name", + "type": "string" + }, + { + "description": "the ID of the management server", "name": "id", "type": "string" }, { - "description": "Details of the Counter.", - "name": "counter", - "type": "list" + "description": "the amount of memory used by this Management Server", + "name": "heapmemoryused", + "type": "long" }, { - "description": "the project name of the Condition", - "name": "project", + "description": "the log files and their usage on disk", + "name": "loginfo", "type": "string" }, { - "description": "zone id of counter", - "name": "zoneid", + "description": "the time these statistics were collected", + "name": "collectiontime", + "type": "date" + }, + { + "description": "the current cpu load", + "name": "cpuload", "type": "string" }, { - "description": "the project id of the Condition.", - "name": "projectid", + "description": "Virtual size of the fully loaded process", + "name": "systemmemoryvirtualsize", "type": "string" }, { - "description": "Relational Operator to be used with threshold.", - "name": "relationaloperator", + "description": "the number of client sessions active on this Management Server", + "name": "sessions", + "type": "long" + }, + { + "description": "Amount of memory used", + "name": "systemmemoryused", "type": "string" }, - {} - ] - }, - { - "description": "Updates a network serviceProvider of a physical network", - "isasync": true, - "name": "updateNetworkServiceProvider", - "params": [ { - "description": "the list of services to be enabled for this physical network service provider", - "length": 255, - "name": "servicelist", - "required": false, - "type": "list" + "description": "the system is running against a local database", + "name": "dbislocal", + "type": "boolean" }, { - "description": "network service provider id", - "length": 255, - "name": "id", - "related": "addNetworkServiceProvider,listNetworkServiceProviders,updateNetworkServiceProvider,listTrafficTypes", - "required": true, - "type": "uuid" + "description": "the name of the OS distribution running on the management server", + "name": "osdistribution", + "type": "string" }, { - "description": "Enabled/Disabled/Shutdown the physical network service provider", - "length": 255, - "name": "state", - "required": false, + "description": "Free system memory", + "name": "systemmemoryfree", "type": "string" - } - ], - "related": "addNetworkServiceProvider,listNetworkServiceProviders,listTrafficTypes", - "response": [ + }, { - "description": "services for this provider", - "name": "servicelist", - "type": "list" + "description": "The number of daemon threads", + "name": "threadsdaemoncount", + "type": "integer" }, { - "description": "state of the network provider", - "name": "state", + "description": "the last time this Management Server was started", + "name": "lastserverstart", + "type": "date" + }, + { + "description": "the running OS kernel version for this Management Server", + "name": "kernelversion", + "type": "string" + }, + { + "description": "the version of the management server", + "name": "version", "type": "string" }, { @@ -27506,54 +28592,65 @@ "name": "jobid", "type": "string" }, + { + "description": "the system has a usage server running locally", + "name": "usageislocal", + "type": "boolean" + }, {}, { - "description": "the destination physical network", - "name": "destinationphysicalnetworkid", - "type": "string" + "description": "the system load for user, and system processes and the system idle cycles", + "name": "systemcycleusage", + "type": "long[]" }, { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", - "type": "string" + "description": "the state of the management server", + "name": "state", + "type": "state" }, { - "description": "uuid of the network provider", - "name": "id", + "description": "Total system memory", + "name": "systemmemorytotal", "type": "string" }, { - "description": "the provider name", - "name": "name", - "type": "string" + "description": "the total system cpu capacity", + "name": "systemtotalcpucycles", + "type": "double" }, { - "description": "true if individual services can be enabled/disabled", - "name": "canenableindividualservice", - "type": "boolean" + "description": "The number of waiting threads", + "name": "threadswaitingcount", + "type": "integer" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "the version of the java distribution running the management server process", + "name": "javaversion", + "type": "string" + }, + { + "description": "the number of processors available to the JVM", + "name": "availableprocessors", "type": "integer" + }, + { + "description": "the last time the host on which this Management Server runs was booted", + "name": "lastboottime", + "type": "date" + }, + { + "description": "the last time this Management Server was stopped", + "name": "lastserverstop", + "type": "date" } ], - "since": "3.0.0" + "since": "4.17.0" }, { "description": "Removes a virtual machine or a list of virtual machines from a load balancer rule.", "isasync": true, "name": "removeFromLoadBalancerRule", "params": [ - { - "description": "The ID of the load balancer rule", - "length": 255, - "name": "id", - "related": "createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,listIpForwardingRules", - "required": true, - "type": "uuid" - }, { "description": "VM ID and IP map, vmidipmap[0].vmid=1 vmidipmap[0].ip=10.1.1.75", "length": 255, @@ -27569,20 +28666,23 @@ "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance", "required": false, "type": "list" + }, + { + "description": "The ID of the load balancer rule", + "length": 255, + "name": "id", + "related": "createIpv6FirewallRule,updateIpv6FirewallRule,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,listIpForwardingRules", + "required": true, + "type": "uuid" } ], "response": [ + {}, { - "description": "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", @@ -27590,9 +28690,14 @@ }, {}, { - "description": "the current status of the latest async job acting 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" } ] }, @@ -27602,19 +28707,18 @@ "name": "listInstanceGroups", "params": [ { - "description": "list only resources belonging to the domain specified", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", + "name": "listall", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { "description": "list instance groups by ID", @@ -27625,40 +28729,40 @@ "type": "uuid" }, { - "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": "", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "pagesize", + "name": "account", "required": false, - "type": "integer" + "type": "string" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "List by keyword", "length": 255, - "name": "isrecursive", + "name": "keyword", "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", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "listall", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "list objects by project", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "name": "isrecursive", "required": false, - "type": "uuid" + "type": "boolean" }, { "description": "list instance groups by name", @@ -27668,71 +28772,72 @@ "type": "string" }, { - "description": "", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "page", + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", "required": false, - "type": "integer" + "type": "uuid" } ], "related": "createInstanceGroup,updateInstanceGroup", "response": [ - { - "description": "the project name of the instance group", - "name": "project", - "type": "string" - }, + {}, { "description": "the domain name of the instance group", "name": "domain", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "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 account owning the instance group", + "name": "account", + "type": "string" }, { "description": "the project ID of the instance group", "name": "projectid", "type": "string" }, - {}, { - "description": "the name of the instance group", - "name": "name", + "description": "the project name of the instance group", + "name": "project", "type": "string" }, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "the account owning the instance group", - "name": "account", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the domain ID of the instance group", - "name": "domainid", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + {}, + { + "description": "time and date the instance group was created", + "name": "created", + "type": "date" + }, + { + "description": "the name of the instance group", + "name": "name", "type": "string" }, { "description": "the ID of the instance group", "name": "id", "type": "string" - }, - { - "description": "time and date the instance group was created", - "name": "created", - "type": "date" } ] }, @@ -27741,6 +28846,14 @@ "isasync": true, "name": "migrateSecondaryStorageData", "params": [ + { + "description": "id(s) of the destination secondary storage pool(s) to which the templates are to be migrated", + "length": 255, + "name": "destpools", + "related": "addSecondaryStorage,listSwifts,updateImageStore,addImageStore,addImageStoreS3,listImageStores,updateCloudToUseObjectStore", + "required": true, + "type": "list" + }, { "description": "id of the image store from where the data is to be migrated", "length": 255, @@ -27755,28 +28868,17 @@ "name": "migrationtype", "required": false, "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": "Response message from migration of secondary storage data objects", - "name": "message", - "type": "string" - }, { "description": "Type of migration requested for", "name": "migrationtype", "type": "string" }, + {}, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", @@ -27787,13 +28889,16 @@ "name": "jobid", "type": "string" }, - {}, + { + "description": "Response message from migration of secondary storage data objects", + "name": "message", + "type": "string" + }, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" - }, - {} + } ], "since": "4.15.0" }, @@ -27813,7 +28918,7 @@ "description": "the gateway id we are creating static route for", "length": 255, "name": "gatewayid", - "related": "createPrivateGateway", + "related": "createPrivateGateway,createPrivateGateway", "required": true, "type": "uuid" } @@ -27821,18 +28926,18 @@ "related": "listStaticRoutes", "response": [ { - "description": "the project name of the static route", - "name": "project", + "description": "the project id of the static route", + "name": "projectid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the ID of the domain associated with the static route", + "name": "domainid", + "type": "string" }, { - "description": "the project id of the static route", - "name": "projectid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -27840,40 +28945,27 @@ "name": "domain", "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": "static route CIDR", + "name": "cidr", "type": "string" }, { "description": "the list of resource tags associated with static route", "name": "tags", "response": [ - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, { "description": "tag value", "name": "value", "type": "string" }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, { "description": "the project id the tag belongs to", "name": "projectid", @@ -27884,6 +28976,11 @@ "name": "project", "type": "string" }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, { "description": "the domain associated with the tag", "name": "domain", @@ -27898,6 +28995,21 @@ "description": "customer associated with the tag", "name": "customer", "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" } ], "type": "list" @@ -27907,36 +29019,29 @@ "name": "state", "type": "string" }, - {}, - { - "description": "VPC the static route belongs to", - "name": "vpcid", - "type": "string" - }, { - "description": "the account associated with the static route", - "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 domain associated with the static route", - "name": "domainid", + "description": "the ID of static route", + "name": "id", "type": "string" }, { - "description": "static route CIDR", - "name": "cidr", + "description": "the project name of the static route", + "name": "project", "type": "string" }, - {}, { - "description": "VPC gateway the route is created for", - "name": "gatewayid", + "description": "VPC the static route belongs to", + "name": "vpcid", "type": "string" }, { - "description": "the ID of static route", - "name": "id", + "description": "the account associated with the static route", + "name": "account", "type": "string" } ] @@ -27946,111 +29051,48 @@ "isasync": true, "name": "destroyVolume", "params": [ - { - "description": "If true is passed, the volume is expunged immediately. False by default.", - "length": 255, - "name": "expunge", - "required": false, - "since": "4.6.0", - "type": "boolean" - }, { "description": "The ID of the volume", "length": 255, "name": "id", - "related": "attachVolume,createVolume,updateVolume,detachVolume,listVolumes,migrateVolume,resizeVolume,destroyVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", + "related": "attachVolume,createVolume,updateVolume,detachVolume,listVolumes,migrateVolume,resizeVolume,destroyVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", "required": true, "type": "uuid" - } - ], - "related": "attachVolume,createVolume,updateVolume,detachVolume,listVolumes,migrateVolume,resizeVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", - "response": [ - { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", - "type": "string" - }, - { - "description": "name of the disk volume", - "name": "name", - "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": "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 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 domain associated with the tag", - "name": "domain", - "type": "string" - } - ], - "type": "set" - }, + "description": "If true is passed, the volume is expunged immediately. False by default.", + "length": 255, + "name": "expunge", + "required": false, + "since": "4.6.0", + "type": "boolean" + } + ], + "related": "attachVolume,createVolume,updateVolume,detachVolume,listVolumes,migrateVolume,resizeVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", + "response": [ { - "description": "ID of the snapshot from which this volume was created", - "name": "snapshotid", + "description": "name of the virtual machine", + "name": "vmname", "type": "string" }, { - "description": "need quiesce vm or not when taking snapshot", - "name": "quiescevm", - "type": "boolean" + "description": "max iops of the disk volume", + "name": "maxiops", + "type": "long" }, { "description": "pod id of the volume", "name": "podid", "type": "string" }, - {}, { - "description": "the status of the volume", - "name": "status", + "description": "ID of the disk offering", + "name": "diskofferingid", + "type": "string" + }, + { + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { @@ -28059,33 +29101,53 @@ "type": "date" }, { - "description": "the chain info of the volume", - "name": "chaininfo", + "description": "display name of the virtual machine", + "name": "vmdisplayname", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "name of the service offering for root disk", + "name": "serviceofferingname", "type": "string" }, { - "description": "cluster name where the volume is allocated", - "name": "clustername", + "description": "id of the virtual machine", + "name": "virtualmachineid", "type": "string" }, { - "description": "the bytes allocated", - "name": "physicalsize", - "type": "long" + "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 alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", + "type": "string" }, { - "description": "name of the availability zone", - "name": "zonename", + "description": "the domain associated with the disk volume", + "name": "domain", + "type": "string" + }, + { + "description": "pod name of the volume", + "name": "podname", + "type": "string" + }, + { + "description": "the account associated with the disk volume", + "name": "account", + "type": "string" + }, + { + "description": "the display text of the service offering for root disk", + "name": "serviceofferingdisplaytext", + "type": "string" + }, + { + "description": "ID of the availability zone", + "name": "zoneid", "type": "string" }, { @@ -28094,18 +29156,18 @@ "type": "integer" }, { - "description": "the account associated with the disk volume", - "name": "account", + "description": "state of the virtual machine", + "name": "vmstate", "type": "string" }, { - "description": "the display text of the disk offering", - "name": "diskofferingdisplaytext", + "description": "ID of the snapshot from which this volume was created", + "name": "snapshotid", "type": "string" }, { - "description": "the ID of the domain associated with the disk volume", - "name": "domainid", + "description": "volume uuid that is given by virtualisation provider (only for VMware)", + "name": "externaluuid", "type": "string" }, { @@ -28114,9 +29176,9 @@ "type": "boolean" }, { - "description": "the write (bytes) of disk on the vm", - "name": "diskkbswrite", - "type": "long" + "description": "the project id of the vpn", + "name": "projectid", + "type": "string" }, { "description": "bytes read rate of the disk volume", @@ -28124,230 +29186,278 @@ "type": "long" }, { - "description": "type of the disk volume (ROOT or DATADISK)", - "name": "type", + "description": "the display text of the disk offering", + "name": "diskofferingdisplaytext", "type": "string" }, { - "description": "id of the primary storage hosting the disk volume; returned to admin user only", - "name": "storageid", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { - "description": "the read (bytes) of disk on the vm", - "name": "diskkbsread", - "type": "long" - }, - { - "description": "display name of the virtual machine", - "name": "vmdisplayname", + "description": "the path of the volume", + "name": "path", "type": "string" }, { - "description": "ID of the service offering for root disk", - "name": "serviceofferingid", + "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", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "pod name of the volume", - "name": "podname", + "description": "shared or local storage", + "name": "storagetype", "type": "string" }, { - "description": "state of the virtual machine", - "name": "vmstate", - "type": "string" + "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 list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + } + ], + "type": "set" }, { - "description": "ID of the disk volume", - "name": "id", - "type": "string" + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "size of the disk volume", + "name": "size", + "type": "long" }, { - "description": "the date the disk volume was created", - "name": "created", - "type": "date" + "description": "provisioning type used to create volumes.", + "name": "provisioningtype", + "type": "string" }, { - "description": "the project id of the vpn", - "name": "projectid", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { - "description": "the domain associated with the disk volume", - "name": "domain", - "type": "string" + "description": "the date the disk volume was created", + "name": "created", + "type": "date" }, { - "description": "the boolean state of whether the volume is destroyed or not", - "name": "destroyed", + "description": "an optional field whether to the display the volume to the end user or not.", + "name": "displayvolume", "type": "boolean" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", "type": "string" }, { - "description": "max iops of the disk volume", - "name": "maxiops", + "description": "the bytes actually consumed on disk", + "name": "virtualsize", "type": "long" }, { - "description": "io requests write rate of the disk volume per the disk offering", - "name": "diskIopsWriteRate", + "description": "the bytes allocated", + "name": "physicalsize", "type": "long" }, { - "description": "name of the service offering for root disk", - "name": "serviceofferingname", + "description": "name of the disk volume", + "name": "name", "type": "string" }, { - "description": "min iops of the disk volume", - "name": "miniops", + "description": "IO requests read rate of the disk volume per the disk offering", + "name": "diskIopsReadRate", "type": "long" }, { - "description": "Hypervisor the volume belongs to", - "name": "hypervisor", - "type": "string" + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" }, { - "description": "name of the primary storage hosting the disk volume", - "name": "storage", + "description": "the chain info of the volume", + "name": "chaininfo", "type": "string" }, { - "description": "provisioning type used to create volumes.", - "name": "provisioningtype", - "type": "string" + "description": "bytes write rate of the disk volume", + "name": "diskBytesWriteRate", + "type": "long" }, { - "description": "ID of the availability zone", - "name": "zoneid", + "description": "ID of the disk volume", + "name": "id", "type": "string" }, + {}, { - "description": "name of the virtual machine", - "name": "vmname", + "description": "Hypervisor the volume belongs to", + "name": "hypervisor", "type": "string" }, { - "description": "shared or local storage", - "name": "storagetype", + "description": "name of the disk offering", + "name": "diskofferingname", "type": "string" }, { - "description": "the path of the volume", - "name": "path", + "description": "the status of the volume", + "name": "status", "type": "string" }, { - "description": "id of the virtual machine", - "name": "virtualmachineid", + "description": "cluster name where the volume is allocated", + "name": "clustername", "type": "string" }, { - "description": "the write (io) of disk on the vm", + "description": "the write (IO) of disk on the vm", "name": "diskiowrite", "type": "long" }, { - "description": "ID of the disk offering", - "name": "diskofferingid", - "type": "string" - }, - { - "description": "cluster id of the volume", - "name": "clusterid", + "description": "the project name of the vpn", + "name": "project", "type": "string" }, { - "description": "name of the disk offering", - "name": "diskofferingname", + "description": "ID of the service offering for root disk", + "name": "serviceofferingid", "type": "string" }, { - "description": "the project name of the vpn", - "name": "project", - "type": "string" + "description": "true if storage snapshot is supported for the volume, false otherwise", + "name": "supportsstoragesnapshot", + "type": "boolean" }, + {}, { - "description": "the disk utilization", - "name": "utilization", + "description": "cluster id of the volume", + "name": "clusterid", "type": "string" }, { - "description": "size of the disk volume", - "name": "size", + "description": "the read (IO) of disk on the vm", + "name": "diskioread", "type": "long" }, { - "description": "the display text of the service offering for root disk", - "name": "serviceofferingdisplaytext", - "type": "string" - }, - { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the 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": "the read (io) of disk on the vm", - "name": "diskioread", - "type": "long" + "description": "the state of the disk volume", + "name": "state", + "type": "string" }, - {}, { - "description": "true if storage snapshot is supported for the volume, false otherwise", - "name": "supportsstoragesnapshot", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "io requests read rate of the disk volume per the disk offering", - "name": "diskIopsReadRate", + "description": "id of the primary storage hosting the disk volume; returned to admin user only", + "name": "storageid", + "type": "string" + }, + { + "description": "IO requests write rate of the disk volume per the disk offering", + "name": "diskIopsWriteRate", "type": "long" }, { - "description": "the state of the disk volume", - "name": "state", + "description": "the ID of the domain associated with the disk volume", + "name": "domainid", "type": "string" }, { - "description": "bytes write rate of the disk volume", - "name": "diskBytesWriteRate", + "description": "min iops of the disk volume", + "name": "miniops", "type": "long" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "the boolean state of whether the volume is destroyed or not", + "name": "destroyed", + "type": "boolean" + }, + { + "description": "name of the primary storage hosting the disk volume", + "name": "storage", "type": "string" }, { - "description": "an optional field whether to the display the volume to the end user or not.", - "name": "displayvolume", - "type": "boolean" + "description": "type of the disk volume (ROOT or DATADISK)", + "name": "type", + "type": "string" } ], "since": "4.14.0" @@ -28358,66 +29468,66 @@ "name": "addTrafficType", "params": [ { - "description": "The network name label of the physical device dedicated to this traffic on a Hyperv host", + "description": "the trafficType to be added to the physical network", "length": 255, - "name": "hypervnetworklabel", - "required": false, + "name": "traffictype", + "required": true, "type": "string" }, { - "description": "Used if physical network has multiple isolation types and traffic type is public. Choose which isolation method. Valid options currently 'vlan' or 'vxlan', defaults to 'vlan'.", + "description": "The network name label of the physical device dedicated to this traffic on a KVM host", "length": 255, - "name": "isolationmethod", + "name": "kvmnetworklabel", "required": false, "type": "string" }, { - "description": "the trafficType to be added to the physical network", + "description": "The network name of the physical device dedicated to this traffic on an OVM3 host", "length": 255, - "name": "traffictype", - "required": true, + "name": "ovm3networklabel", + "required": false, "type": "string" }, { - "description": "the Physical Network ID", + "description": "The network name label of the physical device dedicated to this traffic on a Hyperv host", "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork,updatePhysicalNetwork", - "required": true, - "type": "uuid" + "name": "hypervnetworklabel", + "required": false, + "type": "string" }, { - "description": "The network name of the physical device dedicated to this traffic on an OVM3 host", + "description": "The network name label of the physical device dedicated to this traffic on a VMware host", "length": 255, - "name": "ovm3networklabel", + "name": "vmwarenetworklabel", "required": false, "type": "string" }, { - "description": "The VLAN id to be used for Management traffic by VMware host", + "description": "Used if physical network has multiple isolation types and traffic type is public. Choose which isolation method. Valid options currently 'vlan' or 'vxlan', defaults to 'vlan'.", "length": 255, - "name": "vlan", + "name": "isolationmethod", "required": false, "type": "string" }, { - "description": "The network name label of the physical device dedicated to this traffic on a XenServer host", + "description": "the Physical Network ID", "length": 255, - "name": "xennetworklabel", - "required": false, - "type": "string" + "name": "physicalnetworkid", + "related": "createPhysicalNetwork,updatePhysicalNetwork", + "required": true, + "type": "uuid" }, { - "description": "The network name label of the physical device dedicated to this traffic on a VMware host", + "description": "The VLAN id to be used for Management traffic by VMware host", "length": 255, - "name": "vmwarenetworklabel", + "name": "vlan", "required": false, "type": "string" }, { - "description": "The network name label of the physical device dedicated to this traffic on a KVM host", + "description": "The network name label of the physical device dedicated to this traffic on a XenServer host", "length": 255, - "name": "kvmnetworklabel", + "name": "xennetworklabel", "required": false, "type": "string" } @@ -28425,45 +29535,44 @@ "related": "", "response": [ { - "description": "The network name of the physical device dedicated to this traffic on an OVM3 host", - "name": "ovm3networklabel", + "description": "The network name label of the physical device dedicated to this traffic on a VMware host", + "name": "vmwarenetworklabel", "type": "string" }, { - "description": "The network name label of the physical device dedicated to this traffic on a VMware host", - "name": "vmwarenetworklabel", + "description": "the physical network this belongs to", + "name": "physicalnetworkid", + "type": "string" + }, + { + "description": "The network name label of the physical device dedicated to this traffic on a HyperV host", + "name": "hypervnetworklabel", "type": "string" }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "The network name label of the physical device dedicated to this traffic on a XenServer host", - "name": "xennetworklabel", + "description": "The network name of the physical device dedicated to this traffic on an OVM3 host", + "name": "ovm3networklabel", "type": "string" }, - {}, { "description": "The network name label of the physical device dedicated to this traffic on a KVM host", "name": "kvmnetworklabel", "type": "string" }, - {}, - { - "description": "id of the network provider", - "name": "id", - "type": "string" - }, { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", + "description": "the trafficType to be added to the physical network", + "name": "traffictype", "type": "string" }, { - "description": "The network name label of the physical device dedicated to this traffic on a HyperV host", - "name": "hypervnetworklabel", + "description": "id of the network provider", + "name": "id", "type": "string" }, { @@ -28472,10 +29581,11 @@ "type": "string" }, { - "description": "the trafficType to be added to the physical network", - "name": "traffictype", + "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" }, @@ -28488,18 +29598,16 @@ "description": "the ID of the private gateway", "length": 255, "name": "id", - "related": "createPrivateGateway", + "related": "createPrivateGateway,createPrivateGateway", "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", @@ -28511,10 +29619,12 @@ "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" } ] }, @@ -28523,6 +29633,14 @@ "isasync": false, "name": "listLoadBalancerRuleInstances", "params": [ + { + "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, @@ -28531,40 +29649,32 @@ "type": "integer" }, { - "description": "true if listing all virtual machines currently applied to the load balancer rule; default is true", + "description": "List by keyword", "length": 255, - "name": "applied", + "name": "keyword", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "true if load balancer rule VM IP information to be included; default is false", + "description": "", "length": 255, - "name": "lbvmips", + "name": "pagesize", "required": false, - "type": "boolean" + "type": "integer" }, { - "description": "List by keyword", + "description": "true if listing all virtual machines currently applied to the load balancer rule; default is true", "length": 255, - "name": "keyword", + "name": "applied", "required": false, - "type": "string" - }, - { - "description": "the ID of the load balancer rule", - "length": 255, - "name": "id", - "related": "createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,listIpForwardingRules", - "required": true, - "type": "uuid" + "type": "boolean" }, { - "description": "", + "description": "true if load balancer rule VM IP information to be included; default is false", "length": 255, - "name": "pagesize", + "name": "lbvmips", "required": false, - "type": "integer" + "type": "boolean" } ], "related": "listLoadBalancerRuleInstances", @@ -28579,18 +29689,18 @@ "name": "loadbalancerruleinstance", "type": "uservmresponse" }, - {}, - {}, + { + "description": "the UUID of the latest async job acting on 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" - } + {}, + {} ] }, { @@ -28608,28 +29718,28 @@ } ], "response": [ - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - }, - {}, {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "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" - } + }, + {} ] }, { @@ -28638,11 +29748,12 @@ "name": "updateDomain", "params": [ { - "description": "Network domain for the domain's networks; empty string will update domainName with NULL value", + "description": "ID of domain to update", "length": 255, - "name": "networkdomain", - "required": false, - "type": "string" + "name": "id", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", + "required": true, + "type": "uuid" }, { "description": "updates domain with this name", @@ -28652,110 +29763,94 @@ "type": "string" }, { - "description": "ID of domain to update", + "description": "Network domain for the domain's networks; empty string will update domainName with NULL value", "length": 255, - "name": "id", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", - "required": true, - "type": "uuid" + "name": "networkdomain", + "required": false, + "type": "string" } ], "related": "createDomain,listDomainChildren,listDomains,listDomains", "response": [ { - "description": "the total number of vpcs the domain can own", - "name": "vpclimit", + "description": "the total memory (in MB) the domain can own", + "name": "memorylimit", "type": "string" }, { - "description": "the total number of cpu cores available to be created for this domain", - "name": "cpuavailable", + "description": "the total number of templates available to be created by this domain", + "name": "templateavailable", "type": "string" }, { - "description": "the date when this domain was created", - "name": "created", - "type": "date" - }, - { - "description": "the total primary storage space (in GiB) owned by domain", - "name": "primarystoragetotal", - "type": "long" + "description": "details for the domain", + "name": "domaindetails", + "type": "map" }, { - "description": "the ID of the domain", - "name": "id", + "description": "the total number of vpcs the domain can own", + "name": "vpclimit", "type": "string" }, { - "description": "the state of the domain", - "name": "state", + "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", + "description": "the domain name of the parent domain", + "name": "parentdomainname", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the total number of projects being administrated by this domain", + "name": "projecttotal", + "type": "long" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the total number of public ip addresses this domain can acquire", + "name": "iplimit", "type": "string" }, { - "description": "the total number of projects available for administration by this domain", - "name": "projectavailable", - "type": "string" + "description": "the level of the domain", + "name": "level", + "type": "integer" }, { - "description": "the total secondary storage space (in GiB) available to be used for this domain", - "name": "secondarystorageavailable", + "description": "the total number of virtual machines that can be deployed by this domain", + "name": "vmlimit", "type": "string" }, { - "description": "the total number of public ip addresses available for this domain to acquire", - "name": "ipavailable", + "description": "the domain ID of the parent domain", + "name": "parentdomainid", "type": "string" }, { - "description": "the total volume which can be used by this domain", - "name": "volumelimit", + "description": "the network domain", + "name": "networkdomain", "type": "string" }, { - "description": "whether the domain has one or more sub-domains", - "name": "haschild", - "type": "boolean" + "description": "the total number of networks available to be created for this domain", + "name": "networkavailable", + "type": "string" }, { - "description": "the total number of snapshots stored by this domain", - "name": "snapshottotal", + "description": "the total number of virtual machines deployed by this domain", + "name": "vmtotal", "type": "long" }, { - "description": "the total secondary storage space (in GiB) owned by domain", - "name": "secondarystoragetotal", - "type": "float" - }, - { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "the total number of networks available to be created for this domain", - "name": "networkavailable", - "type": "string" + "description": "the total number of vpcs owned by domain", + "name": "vpctotal", + "type": "long" }, { - "description": "the total number of templates available to be created by this domain", - "name": "templateavailable", - "type": "string" + "description": "the total number of cpu cores owned by domain", + "name": "cputotal", + "type": "long" }, { "description": "the total number of networks owned by domain", @@ -28763,161 +29858,176 @@ "type": "long" }, { - "description": "the total memory (in MB) owned by domain", - "name": "memorytotal", + "description": "the total number of templates which have been created by this domain", + "name": "templatetotal", "type": "long" }, { - "description": "the total number of public ip addresses allocated for this domain", - "name": "iptotal", + "description": "the total number of snapshots stored by this domain", + "name": "snapshottotal", "type": "long" }, { - "description": "the total number of vpcs owned by domain", - "name": "vpctotal", - "type": "long" + "description": "the total secondary storage space (in GiB) available to be used for this domain", + "name": "secondarystorageavailable", + "type": "string" }, { - "description": "the total volume available for this domain", - "name": "volumeavailable", + "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 domain", + "name": "cpuavailable", "type": "string" }, { - "description": "details for the domain", - "name": "domaindetails", - "type": "map" + "description": "the total number of projects available for administration by this domain", + "name": "projectavailable", + "type": "string" }, { - "description": "the total number of snapshots which can be stored by this domain", - "name": "snapshotlimit", + "description": "the total number of vpcs available to be created for this domain", + "name": "vpcavailable", "type": "string" }, { - "description": "the total memory (in MB) the domain can own", - "name": "memorylimit", + "description": "the total number of networks the domain can own", + "name": "networklimit", "type": "string" }, - {}, { - "description": "the total number of projects the domain can own", - "name": "projectlimit", + "description": "the total number of snapshots available for this domain", + "name": "snapshotavailable", "type": "string" }, - {}, { - "description": "the total number of virtual machines that can be deployed by this domain", - "name": "vmlimit", + "description": "the total secondary storage space (in GiB) the domain can own", + "name": "secondarystoragelimit", "type": "string" }, { - "description": "the name of the domain", - "name": "name", + "description": "the total number of snapshots which can be stored by this domain", + "name": "snapshotlimit", "type": "string" }, { - "description": "the total number of virtual machines available for this domain to acquire", - "name": "vmavailable", + "description": "the total number of projects the domain can own", + "name": "projectlimit", "type": "string" }, { - "description": "the total volume being used by this domain", - "name": "volumetotal", - "type": "long" + "description": "the date when this domain was created", + "name": "created", + "type": "date" }, { - "description": "the domain name of the parent domain", - "name": "parentdomainname", + "description": "the total primary storage space (in GiB) the domain can own", + "name": "primarystoragelimit", "type": "string" }, { - "description": "the path of the domain", - "name": "path", + "description": "the total primary storage space (in GiB) available to be used for this domain", + "name": "primarystorageavailable", "type": "string" }, { - "description": "the total number of public ip addresses this domain can acquire", - "name": "iplimit", + "description": "the path of the domain", + "name": "path", "type": "string" }, { - "description": "the total secondary storage space (in GiB) the domain can own", - "name": "secondarystoragelimit", + "description": "the total number of templates which can be created by this domain", + "name": "templatelimit", "type": "string" }, { - "description": "the total memory (in MB) available to be created for this domain", - "name": "memoryavailable", + "description": "the total volume available for this domain", + "name": "volumeavailable", "type": "string" }, + {}, { - "description": "the total number of cpu cores the domain can own", - "name": "cpulimit", - "type": "string" + "description": "whether the domain has one or more sub-domains", + "name": "haschild", + "type": "boolean" }, { - "description": "the total number of templates which have been created by this domain", - "name": "templatetotal", + "description": "the total memory (in MB) owned by domain", + "name": "memorytotal", "type": "long" }, { - "description": "the total number of snapshots available for this domain", - "name": "snapshotavailable", + "description": "the name of the domain", + "name": "name", "type": "string" }, { - "description": "the total number of templates which can be created by this domain", - "name": "templatelimit", + "description": "the ID of the domain", + "name": "id", "type": "string" }, { - "description": "the total primary storage space (in GiB) available to be used for this domain", - "name": "primarystorageavailable", + "description": "the total number of public ip addresses allocated for this domain", + "name": "iptotal", + "type": "long" + }, + { + "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 domain", - "name": "cputotal", + "description": "the total volume being used by this domain", + "name": "volumetotal", "type": "long" }, { - "description": "the total number of vpcs available to be created for this domain", - "name": "vpcavailable", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the total number of virtual machines deployed by this domain", - "name": "vmtotal", - "type": "long" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the domain ID of the parent domain", - "name": "parentdomainid", + "description": "the total number of public ip addresses available for this domain to acquire", + "name": "ipavailable", "type": "string" }, { - "description": "the network domain", - "name": "networkdomain", + "description": "the state of the domain", + "name": "state", "type": "string" }, { - "description": "the total number of projects being administrated by this domain", - "name": "projecttotal", - "type": "long" + "description": "the total secondary storage space (in GiB) owned by domain", + "name": "secondarystoragetotal", + "type": "float" }, + {}, { - "description": "the total number of networks the domain can own", - "name": "networklimit", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the total number of virtual machines available for this domain to acquire", + "name": "vmavailable", "type": "string" }, { - "description": "the level of the domain", - "name": "level", - "type": "integer" + "description": "the total primary storage space (in GiB) owned by domain", + "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 cpu cores the domain can own", + "name": "cpulimit", + "type": "string" } ] }, @@ -28926,6 +30036,13 @@ "isasync": true, "name": "updatePhysicalNetwork", "params": [ + { + "description": "Tag the physical network", + "length": 255, + "name": "tags", + "required": false, + "type": "list" + }, { "description": "the VLAN for the physical network", "length": 255, @@ -28940,6 +30057,13 @@ "required": false, "type": "string" }, + { + "description": "Enabled/Disabled", + "length": 255, + "name": "state", + "required": false, + "type": "string" + }, { "description": "physical network id", "length": 255, @@ -28947,69 +30071,50 @@ "related": "createPhysicalNetwork,updatePhysicalNetwork", "required": true, "type": "uuid" - }, - { - "description": "Tag the physical network", - "length": 255, - "name": "tags", - "required": false, - "type": "list" - }, - { - "description": "Enabled/Disabled", - "length": 255, - "name": "state", - "required": false, - "type": "string" } ], "related": "createPhysicalNetwork", "response": [ - { - "description": "zone name of the physical network", - "name": "zonename", - "type": "string" - }, {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, - {}, { - "description": "name of the physical network", - "name": "name", + "description": "the domain id of the physical network owner", + "name": "domainid", "type": "string" }, { - "description": "zone id of the physical network", - "name": "zoneid", + "description": "the speed of the physical network", + "name": "networkspeed", "type": "string" }, + {}, { "description": "Broadcast domain range of the physical network", "name": "broadcastdomainrange", "type": "string" }, { - "description": "the vlan of the physical network", - "name": "vlan", + "description": "comma separated tag", + "name": "tags", "type": "string" }, { - "description": "comma separated tag", - "name": "tags", + "description": "the vlan of the physical network", + "name": "vlan", "type": "string" }, { - "description": "the domain id of the physical network owner", - "name": "domainid", + "description": "name of the physical network", + "name": "name", "type": "string" }, { - "description": "the uuid of the physical network", - "name": "id", + "description": "zone id of the physical network", + "name": "zoneid", "type": "string" }, { @@ -29018,9 +30123,9 @@ "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "zone name of the physical network", + "name": "zonename", + "type": "string" }, { "description": "isolation methods", @@ -29028,8 +30133,13 @@ "type": "string" }, { - "description": "the speed of the physical network", - "name": "networkspeed", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the uuid of the physical network", + "name": "id", "type": "string" } ], @@ -29052,49 +30162,39 @@ "related": "enableAutoScaleVmGroup,listAutoScaleVmGroups,updateAutoScaleVmGroup", "response": [ { - "description": "the project name of the vm profile", - "name": "project", - "type": "string" - }, - { - "description": "is group for display to the regular user", - "name": "fordisplay", - "type": "boolean" - }, - { - "description": "the domain name of the vm profile", - "name": "domain", + "description": "the domain ID of the vm profile", + "name": "domainid", "type": "string" }, - { - "description": "the maximum number of members in the vmgroup, The number of instances in the vm group will be equal to or less than this number.", - "name": "maxmembers", - "type": "int" - }, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the account owning the instance group", - "name": "account", - "type": "string" + "description": "list of scaledown autoscale policies", + "name": "scaledownpolicies", + "type": "list" }, { - "description": "the domain ID of the vm profile", - "name": "domainid", + "description": "is group for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, + { + "description": "the load balancer rule ID", + "name": "lbruleid", "type": "string" }, { - "description": "the frequency at which the conditions have to be evaluated", - "name": "interval", - "type": "int" + "description": "the project id vm profile", + "name": "projectid", + "type": "string" }, + {}, { - "description": "the autoscale vm group ID", - "name": "id", + "description": "the project name of the vm profile", + "name": "project", "type": "string" }, { @@ -29103,14 +30203,13 @@ "type": "list" }, { - "description": "the project id vm profile", - "name": "projectid", - "type": "string" + "description": "the maximum number of members in the vmgroup, The number of instances in the vm group will be equal to or less than this number.", + "name": "maxmembers", + "type": "int" }, - {}, { - "description": "the autoscale profile that contains information about the vms in the vm group.", - "name": "vmprofileid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -29118,26 +30217,37 @@ "name": "state", "type": "string" }, + { + "description": "the autoscale profile that contains information about the vms in the vm group.", + "name": "vmprofileid", + "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 UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the domain name of the vm profile", + "name": "domain", "type": "string" }, { - "description": "the load balancer rule ID", - "name": "lbruleid", + "description": "the account owning the instance group", + "name": "account", "type": "string" }, { - "description": "list of scaledown autoscale policies", - "name": "scaledownpolicies", - "type": "list" - } + "description": "the frequency at which the conditions have to be evaluated", + "name": "interval", + "type": "int" + }, + { + "description": "the autoscale vm group ID", + "name": "id", + "type": "string" + }, + {} ] }, { @@ -29146,20 +30256,27 @@ "name": "createSnapshotPolicy", "params": [ { - "description": "an optional field, whether to the display the policy to the end user or not", + "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": "fordisplay", - "required": false, - "since": "4.4", - "type": "boolean" + "name": "schedule", + "required": true, + "type": "string" }, { - "description": "valid values are HOURLY, DAILY, WEEKLY, and MONTHLY", + "description": "Specifies a timezone for this command. For more information on the timezone parameter, see Time Zone Format.", "length": 255, - "name": "intervaltype", + "name": "timezone", "required": true, "type": "string" }, + { + "description": "an optional field, whether to the display the policy to the end user or not", + "length": 255, + "name": "fordisplay", + "required": false, + "since": "4.4", + "type": "boolean" + }, { "description": "maximum number of snapshots to retain", "length": 255, @@ -29168,11 +30285,12 @@ "type": "integer" }, { - "description": "time the snapshot is scheduled to be taken. Format is:* if HOURLY, MM* if DAILY, MM:HH* if WEEKLY, MM:HH:DD (1-7)* if MONTHLY, MM:HH:DD (1-28)", + "description": "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", "required": true, - "type": "string" + "type": "uuid" }, { "description": "Map of tags (key/value pairs)", @@ -29182,76 +30300,42 @@ "type": "map" }, { - "description": "Specifies a timezone for this command. For more information on the timezone parameter, see Time Zone Format.", + "description": "valid values are HOURLY, DAILY, WEEKLY, and MONTHLY", "length": 255, - "name": "timezone", + "name": "intervaltype", "required": true, "type": "string" - }, - { - "description": "the ID of the disk volume", - "length": 255, - "name": "volumeid", - "related": "attachVolume,createVolume,updateVolume,detachVolume,listVolumes,migrateVolume,resizeVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", - "required": true, - "type": "uuid" } ], "related": "updateSnapshotPolicy", "response": [ - { - "description": "maximum number of snapshots retained", - "name": "maxsnaps", - "type": "int" - }, - { - "description": "time the snapshot is scheduled to be taken.", - "name": "schedule", - "type": "string" - }, - { - "description": "the ID of the disk volume", - "name": "volumeid", - "type": "string" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - {}, { "description": "the list of resource tags associated", "name": "tags", "response": [ { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { @@ -29260,8 +30344,8 @@ "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { @@ -29270,43 +30354,69 @@ "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" } ], "type": "set" }, { - "description": "the time zone of the snapshot policy", - "name": "timezone", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "the interval type of the snapshot policy", "name": "intervaltype", "type": "short" }, - {}, { - "description": "is this policy for display to the regular user", - "name": "fordisplay", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the time zone of the snapshot policy", + "name": "timezone", + "type": "string" + }, + { + "description": "the ID of the disk volume", + "name": "volumeid", + "type": "string" }, { "description": "the ID of the snapshot policy", "name": "id", "type": "string" }, + {}, + { + "description": "maximum number of snapshots retained", + "name": "maxsnaps", + "type": "int" + }, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" + }, + { + "description": "is this policy for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, + { + "description": "time the snapshot is scheduled to be taken.", + "name": "schedule", + "type": "string" } ] }, @@ -29330,22 +30440,22 @@ "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": "any text associated with the success or failure", "name": "displaytext", "type": "string" }, - {}, {} ], "since": "4.11" @@ -29355,6 +30465,13 @@ "isasync": false, "name": "createRolePermission", "params": [ + { + "description": "The API name or wildcard rule such as list*", + "length": 255, + "name": "rule", + "required": true, + "type": "string" + }, { "description": "ID of the role", "length": 255, @@ -29376,26 +30493,19 @@ "name": "permission", "required": true, "type": "string" - }, - { - "description": "The API name or wildcard rule such as list*", - "length": 255, - "name": "rule", - "required": true, - "type": "string" } ], "related": "listRolePermissions", "response": [ + {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "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" }, { @@ -29408,25 +30518,25 @@ "name": "id", "type": "string" }, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the 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 name of the role to which the role permission belongs", - "name": "rolename", + "description": "the ID of the role to which the role permission belongs", + "name": "roleid", "type": "string" }, - {}, { - "description": "the ID of the role to which the role permission belongs", - "name": "roleid", + "description": "the name of the role to which the role permission belongs", + "name": "rolename", "type": "string" } ], @@ -29447,13 +30557,20 @@ "type": "uuid" }, { - "description": "the Pod ID of the system VM", + "description": "the Zone ID of the system VM", "length": 255, - "name": "podid", - "related": "updatePod,createManagementNetworkIpRange", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, "type": "uuid" }, + { + "description": "the name of the system VM", + "length": 255, + "name": "name", + "required": false, + "type": "string" + }, { "description": "the ID of the system VM", "length": 255, @@ -29463,18 +30580,19 @@ "type": "uuid" }, { - "description": "the state of the system VM", + "description": "the Pod ID of the system VM", "length": 255, - "name": "state", + "name": "podid", + "related": "updatePod,createManagementNetworkIpRange", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "", + "description": "the state of the system VM", "length": 255, - "name": "page", + "name": "state", "required": false, - "type": "integer" + "type": "string" }, { "description": "", @@ -29483,13 +30601,6 @@ "required": false, "type": "integer" }, - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - }, { "description": "the system VM type. Possible types are \"consoleproxy\" and \"secondarystoragevm\".", "length": 255, @@ -29498,126 +30609,125 @@ "type": "string" }, { - "description": "the Zone ID of the system VM", + "description": "", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "the name of the system VM", + "description": "the host ID of the system VM", "length": 255, - "name": "name", + "name": "hostid", + "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "the host ID of the system VM", + "description": "List by keyword", "length": 255, - "name": "hostid", - "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost,addBaremetalHost,listExternalLoadBalancers", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" } ], "related": "migrateSystemVm,startSystemVm,changeServiceForSystemVm", "response": [ { - "description": "the job ID associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job.", - "name": "jobid", - "type": "string" + "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 second DNS for the system VM", + "name": "dns2", "type": "string" }, { - "description": "the state of the system VM", - "name": "state", - "type": "string" + "description": "the job status associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job.", + "name": "jobstatus", + "type": "integer" }, { - "description": "the gateway for the system VM", - "name": "gateway", + "description": "the Zone name for the system VM", + "name": "zonename", "type": "string" }, { - "description": "the Pod ID for the system VM", - "name": "podid", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the public MAC address for the system VM", - "name": "publicmacaddress", + "description": "guest vlan range", + "name": "guestvlan", "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 link local netmask for the system vm", - "name": "linklocalnetmask", + "description": "the hostname for the system VM", + "name": "hostname", "type": "string" }, { - "description": "the link local MAC address for the system vm", - "name": "linklocalmacaddress", + "description": "the private IP address for the system VM", + "name": "privateip", "type": "string" }, {}, { - "description": "the link local IP address for the system vm", - "name": "linklocalip", + "description": "the gateway for the system VM", + "name": "gateway", "type": "string" }, { - "description": "the network domain for the system VM", - "name": "networkdomain", + "description": "the host ID for the system VM", + "name": "hostid", "type": "string" }, { - "description": "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 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 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 UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the number of active console sessions for the console proxy system vm", - "name": "activeviewersessions", - "type": "integer" + "description": "the Pod name for the system VM", + "name": "podname", + "type": "string" }, + {}, { - "description": "the system VM type", - "name": "systemvmtype", + "description": "the first DNS for the system VM", + "name": "dns1", "type": "string" }, - {}, { - "description": "the Zone ID for the system VM", - "name": "zoneid", + "description": "the public IP address for the system VM", + "name": "publicip", "type": "string" }, { - "description": "the first DNS for the system VM", - "name": "dns1", + "description": "the network domain for the system VM", + "name": "networkdomain", "type": "string" }, { @@ -29626,23 +30736,38 @@ "type": "string" }, { - "description": "the public netmask for the system VM", - "name": "publicnetmask", + "description": "the private netmask for the system VM", + "name": "privatenetmask", "type": "string" }, { - "description": "the systemvm agent version", - "name": "version", + "description": "the template ID for the system VM", + "name": "templateid", "type": "string" }, { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", + "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 Zone ID for the system VM", + "name": "zoneid", + "type": "string" + }, + { + "description": "the date and time the system VM was created", + "name": "created", + "type": "date" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "the public IP address for the system VM", - "name": "publicip", + "description": "the state of the system VM", + "name": "state", "type": "string" }, { @@ -29651,13 +30776,8 @@ "type": "string" }, { - "description": "the last disconnected date of host", - "name": "disconnected", - "type": "date" - }, - { - "description": "the ID of the system VM", - "name": "id", + "description": "the public MAC address for the system VM", + "name": "publicmacaddress", "type": "string" }, { @@ -29665,59 +30785,49 @@ "name": "privatemacaddress", "type": "string" }, - { - "description": "the hostname for the system VM", - "name": "hostname", - "type": "string" - }, { "description": "public vlan range", "name": "publicvlan", "type": "list" }, { - "description": "the second DNS for the system VM", - "name": "dns2", - "type": "string" - }, - { - "description": "the Pod name for the system VM", - "name": "podname", + "description": "the template name for the system VM", + "name": "templatename", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the system VM type", + "name": "systemvmtype", "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" }, { - "description": "the Zone name for the system VM", - "name": "zonename", + "description": "the Pod ID for the system VM", + "name": "podid", "type": "string" }, { - "description": "the template ID for the system VM", - "name": "templateid", + "description": "the link local IP address for the system vm", + "name": "linklocalip", "type": "string" }, { - "description": "the template name for the system VM", - "name": "templatename", - "type": "string" + "description": "the last disconnected date of host", + "name": "disconnected", + "type": "date" }, { - "description": "guest vlan range", - "name": "guestvlan", - "type": "string" + "description": "the number of active console sessions for the console proxy system vm", + "name": "activeviewersessions", + "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the systemvm agent version", + "name": "version", "type": "string" } ] @@ -29735,12 +30845,11 @@ "type": "string" }, { - "description": "domain ID of the account owning a project", + "description": "name of the project", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains", - "required": false, - "type": "uuid" + "name": "name", + "required": true, + "type": "string" }, { "description": "user ID of the account to be assigned as owner of the project i.e., Project Admin", @@ -29767,38 +30876,49 @@ "type": "uuid" }, { - "description": "name of the project", + "description": "domain ID of the account owning a project", "length": 255, - "name": "name", - "required": true, - "type": "string" + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains", + "required": false, + "type": "uuid" } ], "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", "response": [ { - "description": "the total number of networks owned by project", - "name": "networktotal", - "type": "long" + "description": "the total memory (in MB) available to be created for this project", + "name": "memoryavailable", + "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the account name of the project's owners", + "name": "owner", + "type": "list" }, { - "description": "the total volume being used by this project", - "name": "volumetotal", + "description": "the total number of vpcs the project can own", + "name": "vpclimit", + "type": "string" + }, + { + "description": "the total number of virtual machines deployed by this project", + "name": "vmtotal", "type": "long" }, { - "description": "the state of the project", - "name": "state", + "description": "the total secondary storage space (in GiB) owned by project", + "name": "secondarystoragetotal", + "type": "float" + }, + { + "description": "the domain name where the project belongs to", + "name": "domain", "type": "string" }, { - "description": "the id of the project", - "name": "id", + "description": "the total number of cpu cores the project can own", + "name": "cpulimit", "type": "string" }, { @@ -29806,18 +30926,18 @@ "name": "tags", "response": [ { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { @@ -29831,244 +30951,234 @@ "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" } ], "type": "list" }, { - "description": "the total number of public ip addresses this project can acquire", - "name": "iplimit", - "type": "string" - }, - { - "description": "the account name of the project's owners", - "name": "owner", - "type": "list" - }, - { - "description": "the total number of snapshots available for this project", - "name": "snapshotavailable", - "type": "string" - }, - { - "description": "the total number of virtual machines running for this project", - "name": "vmrunning", - "type": "integer" - }, - { - "description": "the total number of networks the project can own", - "name": "networklimit", - "type": "string" + "description": "the total volume being used by this project", + "name": "volumetotal", + "type": "long" }, { - "description": "the total number of virtual machines available for this project to acquire", - "name": "vmavailable", - "type": "string" + "description": "the total number of snapshots stored by this project", + "name": "snapshottotal", + "type": "long" }, { - "description": "the domain name where the project belongs to", - "name": "domain", + "description": "the total number of cpu cores available to be created for this project", + "name": "cpuavailable", "type": "string" }, { - "description": "the total primary storage space (in GiB) the project can own", - "name": "primarystoragelimit", + "description": "the project account name of the project", + "name": "projectaccountname", "type": "string" }, { - "description": "the total volume available for this project", - "name": "volumeavailable", + "description": "the state of the project", + "name": "state", "type": "string" }, { - "description": "the total 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 total number of public ip addresses allocated for this project", - "name": "iptotal", - "type": "long" + "description": "the total number of virtual machines stopped for this project", + "name": "vmstopped", + "type": "integer" }, { - "description": "the total memory (in MB) available to be created for this project", - "name": "memoryavailable", + "description": "the total number of templates which can be created by this project", + "name": "templatelimit", "type": "string" }, { - "description": "the total number of snapshots which can be stored by this project", - "name": "snapshotlimit", + "description": "the total number of public ip addresses available for this project to acquire", + "name": "ipavailable", "type": "string" }, { - "description": "the total number of snapshots stored by this project", - "name": "snapshottotal", + "description": "the total memory (in MB) owned by project", + "name": "memorytotal", "type": "long" }, { - "description": "the total secondary storage space (in GiB) the project can own", - "name": "secondarystoragelimit", + "description": "the total primary storage space (in GiB) the project can own", + "name": "primarystoragelimit", "type": "string" }, { - "description": "the project account name of the project", - "name": "projectaccountname", + "description": "the total number of templates which have been created by this project", + "name": "templatetotal", + "type": "long" + }, + {}, + { + "description": "the total secondary storage space (in GiB) available to be used for this project", + "name": "secondarystorageavailable", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the date this project was created", + "name": "created", + "type": "date" }, { - "description": "the total number of virtual machines that can be deployed by this project", - "name": "vmlimit", + "description": "the total number of virtual machines available for this project to acquire", + "name": "vmavailable", "type": "string" }, { - "description": "the total number of public ip addresses available for this project to acquire", - "name": "ipavailable", + "description": "the total number of networks the project can own", + "name": "networklimit", "type": "string" }, { - "description": "the total primary storage space (in GiB) available to be used for this project", - "name": "primarystorageavailable", - "type": "string" + "description": "the total number of cpu cores owned by project", + "name": "cputotal", + "type": "long" }, { - "description": "the total number of cpu cores the project can own", - "name": "cpulimit", + "description": "the id of the project", + "name": "id", "type": "string" }, { - "description": "the total number of vpcs available to be created for this project", - "name": "vpcavailable", + "description": "the total volume available for this project", + "name": "volumeavailable", "type": "string" }, { - "description": "the displaytext of the project", - "name": "displaytext", + "description": "the total number of snapshots available for this project", + "name": "snapshotavailable", "type": "string" }, - {}, { "description": "the total number of vpcs owned by project", "name": "vpctotal", "type": "long" }, { - "description": "the total memory (in MB) owned by project", - "name": "memorytotal", - "type": "long" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the UUID of the latest async job acting on 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 volume which can be used by this project", - "name": "volumelimit", - "type": "string" + "description": "the total number of virtual machines running for this project", + "name": "vmrunning", + "type": "integer" }, { - "description": "the total secondary storage space (in GiB) owned by project", - "name": "secondarystoragetotal", - "type": "float" + "description": "the total number of templates available to be created by this project", + "name": "templateavailable", + "type": "string" }, + {}, { - "description": "the total number of cpu cores available to be created for this project", - "name": "cpuavailable", + "description": "the total secondary storage space (in GiB) the project can own", + "name": "secondarystoragelimit", "type": "string" }, { - "description": "the total number of templates which can be created by this project", - "name": "templatelimit", + "description": "the total number of public ip addresses allocated for this project", + "name": "iptotal", + "type": "long" + }, + { + "description": "the total memory (in MB) the project can own", + "name": "memorylimit", "type": "string" }, { - "description": "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 total number of templates available to be created by this project", - "name": "templateavailable", + "description": "the name of the project", + "name": "name", "type": "string" }, { - "description": "the domain id the project belongs to", - "name": "domainid", + "description": "the total volume which can be used by this project", + "name": "volumelimit", "type": "string" }, { - "description": "the date this project was created", - "name": "created", - "type": "date" + "description": "the total primary storage space (in GiB) available to be used for this project", + "name": "primarystorageavailable", + "type": "string" }, { - "description": "the total memory (in MB) the project can own", - "name": "memorylimit", + "description": "the total number of virtual machines that can be deployed by this project", + "name": "vmlimit", "type": "string" }, { - "description": "the total number of virtual machines deployed by this project", - "name": "vmtotal", + "description": "the total number of networks owned by project", + "name": "networktotal", "type": "long" }, { - "description": "the total number of vpcs the project can own", - "name": "vpclimit", + "description": "the total number of vpcs available to be created for this project", + "name": "vpcavailable", "type": "string" }, { - "description": "the total number of virtual machines stopped for this project", - "name": "vmstopped", - "type": "integer" + "description": "the total number of snapshots which can be stored by this project", + "name": "snapshotlimit", + "type": "string" }, { - "description": "the total number of cpu cores owned by project", - "name": "cputotal", + "description": "the total primary storage space (in GiB) owned by project", + "name": "primarystoragetotal", "type": "long" }, { - "description": "the name of the project", - "name": "name", + "description": "the displaytext of the project", + "name": "displaytext", + "type": "string" + }, + { + "description": "the total number of public ip addresses this project can acquire", + "name": "iplimit", "type": "string" }, { "description": "the total number of networks available to be created for this project", "name": "networkavailable", "type": "string" + }, + { + "description": "the domain id the project belongs to", + "name": "domainid", + "type": "string" } ], "since": "3.0.0" @@ -30079,18 +31189,18 @@ "name": "assignCertToLoadBalancer", "params": [ { - "description": "the ID of the load balancer rule", + "description": "the ID of the certificate", "length": 255, - "name": "lbruleid", - "related": "createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,listIpForwardingRules", + "name": "certid", + "related": "uploadSslCert", "required": true, "type": "uuid" }, { - "description": "the ID of the certificate", + "description": "the ID of the load balancer rule", "length": 255, - "name": "certid", - "related": "uploadSslCert", + "name": "lbruleid", + "related": "createIpv6FirewallRule,updateIpv6FirewallRule,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,listIpForwardingRules", "required": true, "type": "uuid" } @@ -30101,11 +31211,7 @@ "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", @@ -30117,7 +31223,11 @@ "name": "jobid", "type": "string" }, - {} + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } ] }, { @@ -30126,16 +31236,16 @@ "name": "addCiscoVnmcResource", "params": [ { - "description": "Hostname or ip address of the Cisco VNMC Controller.", + "description": "Credentials to access the Cisco VNMC Controller API", "length": 255, - "name": "hostname", + "name": "password", "required": true, "type": "string" }, { "description": "Credentials to access the Cisco VNMC Controller API", "length": 255, - "name": "password", + "name": "username", "required": true, "type": "string" }, @@ -30148,9 +31258,9 @@ "type": "uuid" }, { - "description": "Credentials to access the Cisco VNMC Controller API", + "description": "Hostname or ip address of the Cisco VNMC Controller.", "length": 255, - "name": "username", + "name": "hostname", "required": true, "type": "string" } @@ -30162,17 +31272,17 @@ {}, {}, {}, + { + "description": "the UUID of the latest async job acting on 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" } ] }, @@ -30181,11 +31291,18 @@ "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,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", + "related": "attachVolume,createVolume,updateVolume,detachVolume,listVolumes,migrateVolume,resizeVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", "required": false, "type": "uuid" }, @@ -30196,41 +31313,39 @@ "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance", "required": false, "type": "uuid" - }, - { - "description": "the device ID on the virtual machine where volume is detached from", - "length": 255, - "name": "deviceid", - "required": false, - "type": "long" } ], - "related": "attachVolume,createVolume,updateVolume,listVolumes,migrateVolume,resizeVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", + "related": "attachVolume,createVolume,updateVolume,listVolumes,migrateVolume,resizeVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", "response": [ { - "description": "the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached.", - "name": "deviceid", - "type": "long" + "description": "the name of the template for the virtual machine", + "name": "templatename", + "type": "string" }, { - "description": "shared or local storage", - "name": "storagetype", + "description": "provisioning type used to create volumes.", + "name": "provisioningtype", "type": "string" }, { - "description": "the read (io) of disk on the vm", - "name": "diskioread", + "description": "size of the disk volume", + "name": "size", "type": "long" }, { - "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": "state of the virtual machine", - "name": "vmstate", - "type": "string" + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" + }, + { + "description": "the bytes actually consumed on disk", + "name": "virtualsize", + "type": "long" }, { "description": "the name of the ISO attached to the virtual machine", @@ -30238,54 +31353,44 @@ "type": "string" }, { - "description": "the date the volume was attached to a VM instance", - "name": "attached", - "type": "date" - }, - { - "description": "the chain info of the volume", - "name": "chaininfo", - "type": "string" + "description": "true if storage snapshot is supported for the volume, false otherwise", + "name": "supportsstoragesnapshot", + "type": "boolean" }, { - "description": "ID of the disk volume", - "name": "id", + "description": "the ID of the domain associated with the disk volume", + "name": "domainid", "type": "string" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "the display text of the service offering for root disk", + "name": "serviceofferingdisplaytext", "type": "string" }, { - "description": "true if the volume is extractable, false otherwise", - "name": "isextractable", - "type": "boolean" - }, - { - "description": "name of the virtual machine", - "name": "vmname", + "description": "the project name of the vpn", + "name": "project", "type": "string" }, { - "description": "the path of the volume", - "name": "path", + "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" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the display text of the service offering for root disk", - "name": "serviceofferingdisplaytext", + "description": "volume uuid that is given by virtualisation provider (only for VMware)", + "name": "externaluuid", "type": "string" }, { - "description": "the ID of 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 volume to the end user or not.", + "name": "displayvolume", + "type": "boolean" }, { "description": "pod id of the volume", @@ -30293,49 +31398,39 @@ "type": "string" }, { - "description": "the state of the disk volume", - "name": "state", - "type": "string" - }, - { - "description": "name of the availability zone", - "name": "zonename", + "description": "the path of the volume", + "name": "path", "type": "string" }, { - "description": "min iops of the disk volume", - "name": "miniops", - "type": "long" - }, - { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", - "type": "string" + "description": "true if the volume is extractable, false otherwise", + "name": "isextractable", + "type": "boolean" }, { - "description": "the ID of the domain associated with the disk volume", - "name": "domainid", + "description": "ID of the snapshot from which this volume was created", + "name": "snapshotid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the read (IO) of disk on the vm", + "name": "diskioread", + "type": "long" }, { - "description": "Hypervisor the volume belongs to", - "name": "hypervisor", + "description": "the disk utilization", + "name": "utilization", "type": "string" }, { - "description": "need quiesce vm or not when taking snapshot", - "name": "quiescevm", - "type": "boolean" + "description": "the write (IO) of disk on the vm", + "name": "diskiowrite", + "type": "long" }, { - "description": "the bytes actually consumed on disk", - "name": "virtualsize", - "type": "long" + "description": "shared or local storage", + "name": "storagetype", + "type": "string" }, { "description": "display name of the virtual machine", @@ -30343,97 +31438,87 @@ "type": "string" }, { - "description": "the read (bytes) of disk on the vm", - "name": "diskkbsread", - "type": "long" - }, - { - "description": "the domain associated with the disk volume", - "name": "domain", + "description": "cluster name where the volume is allocated", + "name": "clustername", "type": "string" }, { - "description": "the project name of the vpn", - "name": "project", + "description": "ID of the availability zone", + "name": "zoneid", "type": "string" }, { - "description": "the project id of the vpn", - "name": "projectid", + "description": "ID of the service offering for root disk", + "name": "serviceofferingid", "type": "string" }, { - "description": "the write (bytes) of disk on the vm", - "name": "diskkbswrite", - "type": "long" - }, - { - "description": "cluster id of the volume", - "name": "clusterid", + "description": "name of the virtual machine", + "name": "vmname", "type": "string" }, { - "description": "name of the disk volume", - "name": "name", + "description": "the account associated with the disk volume", + "name": "account", "type": "string" }, { - "description": "the bytes allocated", - "name": "physicalsize", - "type": "long" + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", + "type": "string" }, { - "description": "ID of the service offering for root disk", - "name": "serviceofferingid", + "description": "name of the disk offering", + "name": "diskofferingname", "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": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", - "type": "string" + "description": "IO requests read rate of the disk volume per the disk offering", + "name": "diskIopsReadRate", + "type": "long" }, { - "description": "the status of the volume", - "name": "status", - "type": "string" + "description": "bytes write rate of the disk volume", + "name": "diskBytesWriteRate", + "type": "long" }, { "description": "the list of resource tags associated", "name": "tags", "response": [ { - "description": "resource type", - "name": "resourcetype", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "tag value", + "name": "value", "type": "string" }, { @@ -30442,153 +31527,183 @@ "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the project 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": "io requests write rate of the disk volume per the disk offering", - "name": "diskIopsWriteRate", + "description": "pod name of the volume", + "name": "podname", + "type": "string" + }, + { + "description": "min iops of the disk volume", + "name": "miniops", "type": "long" }, { - "description": "size of the disk volume", - "name": "size", + "description": "max iops of the disk volume", + "name": "maxiops", "type": "long" }, { - "description": "the display text of the disk offering", - "name": "diskofferingdisplaytext", + "description": "the date the volume was attached to a VM instance", + "name": "attached", + "type": "date" + }, + { + "description": "Hypervisor the volume belongs to", + "name": "hypervisor", "type": "string" }, + {}, { - "description": "the 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": "provisioning type used to create volumes.", - "name": "provisioningtype", + "description": "name of the primary storage hosting the disk volume", + "name": "storage", "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", + "type": "string" }, { - "description": "max iops of the disk volume", - "name": "maxiops", - "type": "long" + "description": "the status of the volume", + "name": "status", + "type": "string" }, { - "description": "the 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": "id of the primary storage hosting the disk volume; returned to admin user only", - "name": "storageid", + "description": "the date the disk volume was created", + "name": "created", + "type": "date" + }, + { + "description": "ID of the disk volume", + "name": "id", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "type of the disk volume (ROOT or DATADISK)", + "name": "type", + "type": "string" }, { - "description": "name of the primary storage hosting the disk volume", - "name": "storage", + "description": "cluster id of the volume", + "name": "clusterid", "type": "string" }, { - "description": "ID of the availability zone", - "name": "zoneid", + "description": "name of the availability zone", + "name": "zonename", "type": "string" }, - {}, { - "description": "bytes read rate of the disk volume", - "name": "diskBytesReadRate", + "description": "the chain info of the volume", + "name": "chaininfo", + "type": "string" + }, + { + "description": "the bytes allocated", + "name": "physicalsize", "type": "long" }, { - "description": "true if storage snapshot is supported for the volume, false otherwise", - "name": "supportsstoragesnapshot", - "type": "boolean" + "description": "IO requests write rate of the disk volume per the disk offering", + "name": "diskIopsWriteRate", + "type": "long" }, { - "description": "type of the disk volume (ROOT or DATADISK)", - "name": "type", + "description": "name of the disk volume", + "name": "name", "type": "string" }, { - "description": "name of the disk offering", - "name": "diskofferingname", + "description": "the state of the disk volume", + "name": "state", + "type": "string" + }, + { + "description": "name of the service offering for root disk", + "name": "serviceofferingname", "type": "string" }, - {}, { - "description": "cluster name where the volume is allocated", - "name": "clustername", - "type": "string" + "description": "the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached.", + "name": "deviceid", + "type": "long" + }, + { + "description": "bytes read rate of the disk volume", + "name": "diskBytesReadRate", + "type": "long" }, { - "description": "id of the virtual machine", - "name": "virtualmachineid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "pod name of the volume", - "name": "podname", + "description": "id of the primary storage hosting the disk volume; returned to admin user only", + "name": "storageid", "type": "string" }, { - "description": "bytes write rate of the disk volume", - "name": "diskBytesWriteRate", - "type": "long" + "description": "ID of the disk offering", + "name": "diskofferingid", + "type": "string" }, { - "description": "the write (io) of disk on the vm", - "name": "diskiowrite", - "type": "long" + "description": "need quiesce vm or not when taking snapshot", + "name": "quiescevm", + "type": "boolean" }, { - "description": "the date the disk volume was created", - "name": "created", - "type": "date" + "description": "the project id of the vpn", + "name": "projectid", + "type": "string" }, { - "description": "an optional field whether to the display the volume to the end user or not.", - "name": "displayvolume", - "type": "boolean" + "description": "the domain associated with the disk volume", + "name": "domain", + "type": "string" }, + {}, { - "description": "the boolean state of whether the volume is destroyed or not", - "name": "destroyed", - "type": "boolean" + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", + "type": "string" }, { - "description": "ID of the snapshot from which this volume was created", - "name": "snapshotid", + "description": "id of the virtual machine", + "name": "virtualmachineid", "type": "string" }, { - "description": "name of the service offering for root disk", - "name": "serviceofferingname", + "description": "the display text of the disk offering", + "name": "diskofferingdisplaytext", "type": "string" } ] @@ -30610,7 +31725,7 @@ "description": "the ID of the network", "length": 255, "name": "networkid", - "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listF5LoadBalancerNetworks,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listSrxFirewallNetworks,listBrocadeVcsDeviceNetworks", + "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listSrxFirewallNetworks,listBrocadeVcsDeviceNetworks", "required": false, "type": "uuid" }, @@ -30618,7 +31733,7 @@ "description": "the ID of the private gateway", "length": 255, "name": "gatewayid", - "related": "createPrivateGateway", + "related": "createPrivateGateway,createPrivateGateway", "required": false, "type": "uuid" } @@ -30629,6 +31744,11 @@ "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", @@ -30640,11 +31760,6 @@ "name": "jobstatus", "type": "integer" }, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, {} ] }, @@ -30653,6 +31768,14 @@ "isasync": true, "name": "markDefaultZoneForAccount", "params": [ + { + "description": "Marks the account that belongs to the specified domain.", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains", + "required": true, + "type": "uuid" + }, { "description": "Name of the account that is to be marked.", "length": 255, @@ -30668,53 +31791,19 @@ "related": "createZone,updateZone,listZones,listZones", "required": true, "type": "uuid" - }, - { - "description": "Marks the account that belongs to the specified domain.", - "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains", - "required": true, - "type": "uuid" } ], "related": "createAccount,disableAccount,enableAccount,updateAccount,listAccounts,listAccounts", "response": [ { - "description": "the total number of public ip addresses this account can acquire", - "name": "iplimit", - "type": "string" - }, - { - "description": "the type of the role (Admin, ResourceAdmin, DomainAdmin, User)", - "name": "roletype", - "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 cpu cores the account can own", - "name": "cpulimit", - "type": "string" - }, - { - "description": "the total volume being used by this account", - "name": "volumetotal", - "type": "long" - }, - {}, - { - "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 memory (in MB) owned by account", - "name": "memorytotal", - "type": "long" + "description": "account type (admin, domain-admin, user)", + "name": "accounttype", + "type": "integer" }, { "description": "the UUID of the latest async job acting on this object", @@ -30722,33 +31811,33 @@ "type": "string" }, { - "description": "the total primary storage space (in GiB) owned by account", - "name": "primarystoragetotal", - "type": "long" + "description": "the date when this account was created", + "name": "created", + "type": "date" }, { - "description": "the total number of public ip addresses available for this account to acquire", - "name": "ipavailable", + "description": "the total secondary storage space (in GiB) available to be used for this account", + "name": "secondarystorageavailable", "type": "string" }, { - "description": "the total number of virtual machines that can be deployed by this account", - "name": "vmlimit", + "description": "name of the Domain the account belongs to", + "name": "domain", "type": "string" }, { - "description": "the name of the role", - "name": "rolename", + "description": "the total number of public ip addresses available for this account to acquire", + "name": "ipavailable", "type": "string" }, { - "description": "the total number of snapshots which can be stored by this account", - "name": "snapshotlimit", - "type": "string" + "description": "the total number of virtual machines running for this account", + "name": "vmrunning", + "type": "integer" }, { - "description": "path of the Domain the account belongs to", - "name": "domainpath", + "description": "the id of the account", + "name": "id", "type": "string" }, { @@ -30757,59 +31846,68 @@ "type": "string" }, { - "description": "the ID of the role", - "name": "roleid", + "description": "the total number of snapshots stored by this account", + "name": "snapshottotal", + "type": "long" + }, + { + "description": "the total number of vpcs available to be created for this account", + "name": "vpcavailable", "type": "string" }, { - "description": "the total number of projects the account can own", - "name": "projectlimit", + "description": "the total number of cpu cores the account can own", + "name": "cpulimit", "type": "string" }, { - "description": "the total number of projects being administrated by this account", - "name": "projecttotal", + "description": "the total number of networks owned by account", + "name": "networktotal", "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 owned by account", + "name": "cputotal", + "type": "long" }, { - "description": "the total number of virtual machines available for this account to acquire", - "name": "vmavailable", - "type": "string" + "description": "the total number of public ip addresses allocated for this account", + "name": "iptotal", + "type": "long" }, { - "description": "the date when this account was created", - "name": "created", - "type": "date" + "description": "details for the account", + "name": "accountdetails", + "type": "map" }, { - "description": "the total number of virtual machines running for this account", - "name": "vmrunning", + "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 available to be created for this account", - "name": "networkavailable", - "type": "string" + "description": "the total secondary storage space (in GiB) owned by account", + "name": "secondarystoragetotal", + "type": "float" }, - {}, { - "description": "the network domain", - "name": "networkdomain", + "description": "the total memory (in MB) the account can own", + "name": "memorylimit", "type": "string" }, { - "description": "the total number of vpcs owned by account", - "name": "vpctotal", - "type": "long" + "description": "the total primary storage space (in GiB) the account can own", + "name": "primarystoragelimit", + "type": "string" }, { - "description": "the default zone of the account", - "name": "defaultzoneid", + "description": "the network domain", + "name": "networkdomain", "type": "string" }, { @@ -30818,82 +31916,57 @@ "type": "string" }, { - "description": "the total number of networks owned by account", - "name": "networktotal", + "description": "the total number of projects being administrated by this account", + "name": "projecttotal", "type": "long" }, { - "description": "name of the Domain the account belongs to", - "name": "domain", - "type": "string" - }, - { - "description": "the total number of templates available to be created by this account", - "name": "templateavailable", + "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 owned by account", - "name": "cputotal", - "type": "long" - }, - { - "description": "the state of the account", - "name": "state", + "description": "the total number of public ip addresses this account can acquire", + "name": "iplimit", "type": "string" }, { - "description": "the list of acl groups that account belongs to", - "name": "groups", - "type": "list" - }, - { - "description": "the total number of templates which can be created by this account", - "name": "templatelimit", + "description": "the total number of templates available to be created by this account", + "name": "templateavailable", "type": "string" }, { - "description": "the total number of virtual machines stopped for this account", - "name": "vmstopped", - "type": "integer" - }, - { - "description": "the total number of networks the account can own", - "name": "networklimit", + "description": "the total volume available for this account", + "name": "volumeavailable", "type": "string" }, - { - "description": "the total secondary storage space (in GiB) owned by account", - "name": "secondarystoragetotal", - "type": "float" - }, { "description": "the list of users associated with account", "name": "user", "response": [ { - "description": "the ID of the role", - "name": "roleid", + "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", + "description": "the type of the role", + "name": "roletype", "type": "string" }, { - "description": "the source type of the user in lowercase, such as native, ldap, saml2", - "name": "usersource", + "description": "the domain ID of the user", + "name": "domainid", "type": "string" }, { - "description": "the account type of the user", - "name": "accounttype", - "type": "short" + "description": "the timezone user was created in", + "name": "timezone", + "type": "string" }, { - "description": "the user name", - "name": "username", + "description": "the user lastname", + "name": "lastname", "type": "string" }, { @@ -30902,14 +31975,14 @@ "type": "string" }, { - "description": "the user ID", - "name": "id", + "description": "the user email address", + "name": "email", "type": "string" }, { - "description": "the date and time the user account was created", - "name": "created", - "type": "date" + "description": "the name of the role", + "name": "rolename", + "type": "string" }, { "description": "the user state", @@ -30917,13 +31990,8 @@ "type": "string" }, { - "description": "the boolean value representing if the updating target is in caller's child domain", - "name": "iscallerchilddomain", - "type": "boolean" - }, - { - "description": "the account ID of the user", - "name": "accountid", + "description": "the api key of the user", + "name": "apikey", "type": "string" }, { @@ -30932,121 +32000,168 @@ "type": "string" }, { - "description": "the user lastname", - "name": "lastname", - "type": "string" + "description": "the date and time the user account was created", + "name": "created", + "type": "date" }, { - "description": "the api key of the user", - "name": "apikey", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the name of the role", - "name": "rolename", + "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": "the type of the role", - "name": "roletype", + "description": "the user name", + "name": "username", "type": "string" }, { - "description": "the secret key of the user", - "name": "secretkey", + "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 boolean value representing if the updating target is in caller's child domain", + "name": "iscallerchilddomain", + "type": "boolean" }, { - "description": "the domain name of the user", - "name": "domain", + "description": "true if user is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "the ID of the role", + "name": "roleid", "type": "string" }, { - "description": "the user email address", - "name": "email", + "description": "the secret key of the user", + "name": "secretkey", "type": "string" }, { - "description": "the timezone user was created in", - "name": "timezone", + "description": "the user ID", + "name": "id", "type": "string" } ], "type": "list" }, { - "description": "the total memory (in MB) available to be created for this account", - "name": "memoryavailable", + "description": "the total number of virtual machines that can be deployed by this account", + "name": "vmlimit", "type": "string" }, { - "description": "the total number of snapshots available for this account", - "name": "snapshotavailable", + "description": "the default zone of the account", + "name": "defaultzoneid", "type": "string" }, { - "description": "true if the account requires cleanup", - "name": "iscleanuprequired", - "type": "boolean" + "description": "the total number of networks the account can own", + "name": "networklimit", + "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the total number of cpu cores available to be created for this account", + "name": "cpuavailable", + "type": "string" }, { - "description": "the total secondary storage space (in GiB) the account can own", - "name": "secondarystoragelimit", - "type": "string" + "description": "the total number of virtual machines stopped for this account", + "name": "vmstopped", + "type": "integer" }, { - "description": "the total volume available for this account", - "name": "volumeavailable", + "description": "the list of acl groups that account belongs to", + "name": "groups", + "type": "list" + }, + { + "description": "the total number of templates which can be created by this account", + "name": "templatelimit", "type": "string" }, { - "description": "the total memory (in MB) the account can own", - "name": "memorylimit", + "description": "the total number of projects the account can own", + "name": "projectlimit", "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", + "description": "the total number of templates which have been created by this account", + "name": "templatetotal", "type": "long" }, { - "description": "the total number of virtual machines deployed by this account", - "name": "vmtotal", - "type": "long" + "description": "the total memory (in MB) available to be created for this account", + "name": "memoryavailable", + "type": "string" }, { - "description": "the total number of public ip addresses allocated for this account", - "name": "iptotal", - "type": "long" + "description": "the total number of virtual machines available for this account to acquire", + "name": "vmavailable", + "type": "string" }, { - "description": "the total number of projects available for administration by this account", - "name": "projectavailable", + "description": "the total number of vpcs the account can own", + "name": "vpclimit", + "type": "string" + }, + { + "description": "the state of the account", + "name": "state", + "type": "string" + }, + { + "description": "the total number of networks available to be created for this account", + "name": "networkavailable", "type": "string" }, + { + "description": "the name of the role", + "name": "rolename", + "type": "string" + }, + { + "description": "the total number of snapshots available for this account", + "name": "snapshotavailable", + "type": "string" + }, + { + "description": "the total number of vpcs owned by account", + "name": "vpctotal", + "type": "long" + }, + { + "description": "the total volume being used by this account", + "name": "volumetotal", + "type": "long" + }, { "description": "true if account is default, false otherwise", "name": "isdefault", "type": "boolean" }, + {}, { - "description": "the total primary storage space (in GiB) the account can own", - "name": "primarystoragelimit", + "description": "true if the account requires cleanup", + "name": "iscleanuprequired", + "type": "boolean" + }, + {}, + { + "description": "the total secondary storage space (in GiB) the account can own", + "name": "secondarystoragelimit", "type": "string" }, { @@ -31055,48 +32170,48 @@ "type": "string" }, { - "description": "the total number of vpcs the account can own", - "name": "vpclimit", - "type": "string" + "description": "the total number of virtual machines deployed by this account", + "name": "vmtotal", + "type": "long" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" + "description": "the type of the role (Admin, ResourceAdmin, DomainAdmin, User)", + "name": "roletype", + "type": "string" }, { - "description": "details for the account", - "name": "accountdetails", - "type": "map" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the total number of cpu cores available to be created for this account", - "name": "cpuavailable", + "description": "the ID of the role", + "name": "roleid", "type": "string" }, { - "description": "the total number of snapshots stored by this account", - "name": "snapshottotal", - "type": "long" + "description": "the total number of projects available for administration by this account", + "name": "projectavailable", + "type": "string" }, { - "description": "account type (admin, domain-admin, user)", - "name": "accounttype", - "type": "short" + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" }, { - "description": "the total number of vpcs available to be created for this account", - "name": "vpcavailable", + "description": "path of the Domain the account belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the id of the account", - "name": "id", - "type": "string" + "description": "the total memory (in MB) owned by account", + "name": "memorytotal", + "type": "long" }, { - "description": "the total primary storage space (in GiB) available to be used for this account", - "name": "primarystorageavailable", + "description": "the total number of snapshots which can be stored by this account", + "name": "snapshotlimit", "type": "string" } ], @@ -31119,70 +32234,70 @@ "related": "enableOutOfBandManagementForHost,disableOutOfBandManagementForHost,enableOutOfBandManagementForCluster,disableOutOfBandManagementForCluster,issueOutOfBandManagementPowerAction", "response": [ { - "description": "the operation result description", - "name": "description", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {}, - { - "description": "the out-of-band management interface powerState of the host", - "name": "powerstate", - "type": "powerstate" - }, { "description": "the operation result", - "name": "status", - "type": "boolean" - }, - { - "description": "the ID of the host", - "name": "hostid", - "type": "string" + "name": "status", + "type": "boolean" }, {}, + { + "description": "the out-of-band management interface powerState of the host", + "name": "powerstate", + "type": "powerstate" + }, { "description": "the out-of-band management interface address", "name": "address", "type": "string" }, { - "description": "the out-of-band management interface port", - "name": "port", + "description": "the ID of the host", + "name": "hostid", "type": "string" }, - { - "description": "true if out-of-band management is enabled for the host", - "name": "enabled", - "type": "boolean" - }, { "description": "the out-of-band management interface password", "name": "password", "type": "string" }, + { + "description": "the operation result description", + "name": "description", + "type": "string" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the out-of-band management action (if issued)", - "name": "action", + "description": "the out-of-band management interface username", + "name": "username", "type": "string" }, + {}, { - "description": "the out-of-band management driver for the host", - "name": "driver", + "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 UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the out-of-band management action (if issued)", + "name": "action", "type": "string" }, { - "description": "the out-of-band management interface username", - "name": "username", + "description": "the out-of-band management driver for the host", + "name": "driver", "type": "string" } ], @@ -31193,13 +32308,6 @@ "isasync": false, "name": "listLdapUsers", "params": [ - { - "description": "Determines whether all ldap users are returned or just non-cloudstack users. This option is deprecated in favour for the more option rich 'userfilter' parameter", - "length": 255, - "name": "listtype", - "required": false, - "type": "string" - }, { "description": "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, @@ -31208,14 +32316,6 @@ "since": "4.13", "type": "string" }, - { - "description": "linked domain", - "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains", - "required": false, - "type": "uuid" - }, { "description": "List by keyword", "length": 255, @@ -31230,35 +32330,50 @@ "required": false, "type": "integer" }, + { + "description": "linked domain", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains", + "required": false, + "type": "uuid" + }, { "description": "", "length": 255, "name": "pagesize", "required": false, "type": "integer" + }, + { + "description": "Determines whether all ldap users are returned or just non-cloudstack users. This option is deprecated in favour for the more option rich 'userfilter' parameter", + "length": 255, + "name": "listtype", + "required": false, + "type": "string" } ], "related": "", "response": [ + { + "description": "The user's email", + "name": "email", + "type": "string" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - { - "description": "The user's firstname", - "name": "firstname", - "type": "string" - }, + {}, { "description": "The authentication source for this user as known to the system or empty if the user is not yet in cloudstack.", "name": "conflictingusersource", "type": "string" }, - {}, { - "description": "The user's email", - "name": "email", + "description": "The user's firstname", + "name": "firstname", "type": "string" }, { @@ -31266,6 +32381,7 @@ "name": "principal", "type": "string" }, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", @@ -31285,8 +32401,7 @@ "description": "The user's lastname", "name": "lastname", "type": "string" - }, - {} + } ], "since": "4.2.0" }, @@ -31296,10 +32411,10 @@ "name": "revokeCertificate", "params": [ { - "description": "The certificate serial number, as a hex value", + "description": "The certificate CN", "length": 255, - "name": "serial", - "required": true, + "name": "cn", + "required": false, "type": "string" }, { @@ -31310,29 +32425,29 @@ "type": "string" }, { - "description": "The certificate CN", + "description": "The certificate serial number, as a hex value", "length": 255, - "name": "cn", - "required": false, + "name": "serial", + "required": true, "type": "string" } ], "response": [ + {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "the UUID of the latest async job acting on 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", @@ -31348,6 +32463,13 @@ "isasync": false, "name": "changeServiceForSystemVm", "params": [ + { + "description": "name value pairs of custom parameters for cpu, memory and cpunumber. example details[i].name=value", + "length": 255, + "name": "details", + "required": false, + "type": "map" + }, { "description": "the service offering ID to apply to the system vm", "length": 255, @@ -31363,30 +32485,28 @@ "related": "migrateSystemVm,startSystemVm,changeServiceForSystemVm", "required": true, "type": "uuid" - }, - { - "description": "name value pairs of custom parameters for cpu, memory and cpunumber. example details[i].name=value", - "length": 255, - "name": "details", - "required": false, - "type": "map" } ], "related": "migrateSystemVm,startSystemVm", "response": [ { - "description": "the private MAC address for the system VM", - "name": "privatemacaddress", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the systemvm agent version", - "name": "version", + "description": "the hostname for the system VM", + "name": "hostname", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the job status associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job.", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the network domain for the system VM", + "name": "networkdomain", "type": "string" }, { @@ -31395,166 +32515,151 @@ "type": "string" }, { - "description": "the Zone ID for the system VM", - "name": "zoneid", + "description": "the Zone name for the system VM", + "name": "zonename", "type": "string" }, + {}, { - "description": "the public netmask for the system VM", - "name": "publicnetmask", - "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 system vm", - "name": "linklocalip", + "description": "the job ID associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job.", + "name": "jobid", "type": "string" }, { - "description": "the hostname for the system VM", - "name": "hostname", + "description": "the public IP address for the system VM", + "name": "publicip", "type": "string" }, { - "description": "the template name for the system VM", - "name": "templatename", + "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 second DNS for the system VM", - "name": "dns2", + "description": "the private MAC address for the system VM", + "name": "privatemacaddress", "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 public MAC address for the system VM", - "name": "publicmacaddress", + "description": "the template ID for the system VM", + "name": "templateid", "type": "string" }, { - "description": "the agent state of the system VM", - "name": "agentstate", - "type": "string" + "description": "public vlan range", + "name": "publicvlan", + "type": "list" }, { - "description": "the system VM type", - "name": "systemvmtype", + "description": "guest vlan range", + "name": "guestvlan", "type": "string" }, { - "description": "the link local netmask for the system vm", - "name": "linklocalnetmask", + "description": "the link local IP address for the system vm", + "name": "linklocalip", "type": "string" }, { - "description": "the 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 link local MAC address for the system vm", + "name": "linklocalmacaddress", "type": "string" }, - { - "description": "the date and time the system VM was created", - "name": "created", - "type": "date" - }, { "description": "the last disconnected date of host", "name": "disconnected", "type": "date" }, - {}, { - "description": "the gateway for the system VM", - "name": "gateway", + "description": "the systemvm agent version", + "name": "version", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the Zone ID for the system VM", + "name": "zoneid", + "type": "string" }, { - "description": "the network domain for the system VM", - "name": "networkdomain", + "description": "the gateway for the system VM", + "name": "gateway", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "the number of active console sessions for the console proxy system vm", + "name": "activeviewersessions", "type": "integer" }, { - "description": "the host ID for the system VM", - "name": "hostid", - "type": "string" + "description": "the date and time the system VM was created", + "name": "created", + "type": "date" }, { - "description": "the Pod ID for the system VM", - "name": "podid", + "description": "the link local netmask for the system vm", + "name": "linklocalnetmask", "type": "string" }, { - "description": "the state of the system VM", - "name": "state", + "description": "the name of the system VM", + "name": "name", "type": "string" }, + {}, { "description": "the Pod name for the system VM", "name": "podname", "type": "string" }, { - "description": "guest vlan range", - "name": "guestvlan", + "description": "the public MAC address for the system VM", + "name": "publicmacaddress", "type": "string" }, { - "description": "the public IP address for the system VM", - "name": "publicip", + "description": "the private IP address for the system VM", + "name": "privateip", "type": "string" }, { - "description": "the template ID for the system VM", - "name": "templateid", + "description": "the public netmask for the system VM", + "name": "publicnetmask", "type": "string" }, { - "description": "the private netmask for the system VM", - "name": "privatenetmask", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the Zone name for the system VM", - "name": "zonename", + "description": "the host ID for the system VM", + "name": "hostid", "type": "string" }, - {}, { - "description": "the first DNS for the system VM", - "name": "dns1", + "description": "the Pod ID for the system VM", + "name": "podid", "type": "string" }, { - "description": "the private IP address for the system VM", - "name": "privateip", + "description": "the system VM type", + "name": "systemvmtype", "type": "string" }, { - "description": "the link local MAC address for the system vm", - "name": "linklocalmacaddress", + "description": "the second DNS for the system VM", + "name": "dns2", "type": "string" }, { - "description": "public vlan range", - "name": "publicvlan", - "type": "list" + "description": "the first DNS for the system VM", + "name": "dns1", + "type": "string" }, { "description": "the UUID of the latest async job acting on this object", @@ -31562,14 +32667,24 @@ "type": "string" }, { - "description": "the number of active console sessions for the console proxy system vm", - "name": "activeviewersessions", - "type": "integer" + "description": "the state of the system VM", + "name": "state", + "type": "string" }, { - "description": "the name of the system VM", - "name": "name", + "description": "the private netmask for the system VM", + "name": "privatenetmask", + "type": "string" + }, + { + "description": "the template name for the system VM", + "name": "templatename", "type": "string" + }, + { + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" } ] }, @@ -31579,32 +32694,32 @@ "name": "updateSiocInfo", "params": [ { - "description": "Notify if IOPS above this value", + "description": "Storage Pool ID", "length": 255, - "name": "iopsnotifythreshold", + "name": "storageid", + "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities", "required": true, - "type": "integer" + "type": "uuid" }, { - "description": "Zone ID", + "description": "Limit IOPS per GB", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "limitiopspergb", "required": true, - "type": "uuid" + "type": "integer" }, { - "description": "Storage Pool ID", + "description": "Zone ID", "length": 255, - "name": "storageid", - "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": true, "type": "uuid" }, { - "description": "Limit IOPS per GB", + "description": "Notify if IOPS above this value", "length": 255, - "name": "limitiopspergb", + "name": "iopsnotifythreshold", "required": true, "type": "integer" }, @@ -31618,11 +32733,6 @@ ], "related": "", "response": [ - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "The return message from the operation ('Success' if successful)", "name": "msg", @@ -31633,6 +32743,11 @@ "name": "jobid", "type": "string" }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, {}, {} ], @@ -31644,35 +32759,26 @@ "name": "listIpForwardingRules", "params": [ { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - }, - { - "description": "list objects by project", + "description": "Lists all rules applied to the specified VM.", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", + "name": "virtualmachineid", + "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,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": "Lists rule with the specified ID.", + "description": "", "length": 255, - "name": "id", - "related": "createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,listIpForwardingRules", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "Lists all rules applied to the specified VM.", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "virtualmachineid", - "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance", + "name": "account", "required": false, - "type": "uuid" + "type": "string" }, { "description": "list the rule belonging to this public IP address", @@ -31683,39 +32789,40 @@ "type": "uuid" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "account", + "name": "isrecursive", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false", + "description": "List by keyword", "length": 255, - "name": "listall", + "name": "keyword", "required": false, - "type": "boolean" + "type": "string" }, { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, { - "description": "", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "page", + "name": "listall", "required": false, - "type": "integer" + "type": "boolean" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "Lists rule with the specified ID.", "length": 255, - "name": "isrecursive", + "name": "id", + "related": "createIpv6FirewallRule,updateIpv6FirewallRule,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,listIpForwardingRules", "required": false, - "type": "boolean" + "type": "uuid" }, { "description": "list only resources belonging to the domain specified", @@ -31724,24 +32831,31 @@ "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" } ], - "related": "createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule", + "related": "createIpv6FirewallRule,updateIpv6FirewallRule,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule", "response": [ { - "description": "the VM name for the port forwarding rule", - "name": "virtualmachinename", + "description": "the protocol of the port forwarding rule", + "name": "protocol", "type": "string" }, - {}, { - "description": "the ending port of port forwarding rule's private port range", - "name": "privateendport", + "description": "the public ip address for the port forwarding rule", + "name": "ipaddress", "type": "string" }, { - "description": "the starting port of port forwarding rule's private port range", - "name": "privateport", + "description": "the ending port of port forwarding rule's private port range", + "name": "publicendport", "type": "string" }, { @@ -31749,21 +32863,7 @@ "name": "jobstatus", "type": "integer" }, - { - "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 public ip address for the port forwarding rule", - "name": "ipaddress", - "type": "string" - }, + {}, { "description": "is firewall for display to the regular user", "name": "fordisplay", @@ -31774,40 +32874,35 @@ "name": "publicport", "type": "string" }, - {}, - { - "description": "the id of the guest network the port forwarding rule belongs to", - "name": "networkid", - "type": "string" - }, { - "description": "the ending port of port forwarding rule's private port range", - "name": "publicendport", + "description": "the ID of the port forwarding rule", + "name": "id", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the id of the guest network the port forwarding rule belongs to", + "name": "networkid", "type": "string" }, { - "description": "the state of the rule", - "name": "state", + "description": "the ending port of port forwarding rule's private port range", + "name": "privateendport", "type": "string" }, { - "description": "the public ip address id for the port forwarding rule", - "name": "ipaddressid", + "description": "the starting port of port forwarding rule's private port range", + "name": "privateport", "type": "string" }, + {}, { - "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", + "description": "the VM ID for the port forwarding rule", + "name": "virtualmachineid", "type": "string" }, { - "description": "the ID of the port forwarding rule", - "name": "id", + "description": "the VM display name for the port forwarding rule", + "name": "virtualmachinedisplayname", "type": "string" }, { @@ -31815,67 +32910,87 @@ "name": "tags", "response": [ { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the 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": "tag value", - "name": "value", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "resource type", + "name": "resourcetype", "type": "string" } ], "type": "list" }, { - "description": "the protocol of the port forwarding rule", - "name": "protocol", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the 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 vm ip address for the port forwarding rule", "name": "vmguestip", "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" } ] }, @@ -31885,55 +33000,48 @@ "name": "createSnapshot", "params": [ { - "description": "The ID of the disk volume", - "length": 255, - "name": "volumeid", - "related": "attachVolume,createVolume,updateVolume,listVolumes,migrateVolume,resizeVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", - "required": true, - "type": "uuid" - }, - { - "description": "The account of the snapshot. The account parameter must be used with the domainId parameter.", + "description": "asynchronous backup if true", "length": 255, - "name": "account", + "name": "asyncbackup", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "Currently applicable only for managed storage. Valid location types: 'primary', 'secondary'. Default = 'primary'.", + "description": "policy id of the snapshot, if this is null, then use MANUAL_POLICY.", "length": 255, - "name": "locationtype", + "name": "policyid", + "related": "updateSnapshotPolicy", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "quiesce vm if true", + "description": "the name of the snapshot", "length": 255, - "name": "quiescevm", + "name": "name", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "asynchronous backup if true", + "description": "Map of tags (key/value pairs)", "length": 255, - "name": "asyncbackup", + "name": "tags", "required": false, - "type": "boolean" + "type": "map" }, { - "description": "policy id of the snapshot, if this is null, then use MANUAL_POLICY.", + "description": "The ID of the disk volume", "length": 255, - "name": "policyid", - "related": "updateSnapshotPolicy", - "required": false, + "name": "volumeid", + "related": "attachVolume,createVolume,updateVolume,listVolumes,migrateVolume,resizeVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", + "required": true, "type": "uuid" }, { - "description": "the name of the snapshot", + "description": "quiesce vm if true", "length": 255, - "name": "name", + "name": "quiescevm", "required": false, - "type": "string" + "type": "boolean" }, { "description": "The domain ID of the snapshot. If used with the account parameter, specifies a domain for the account associated with the disk volume.", @@ -31944,95 +33052,50 @@ "type": "uuid" }, { - "description": "Map of tags (key/value pairs)", + "description": "Currently applicable only for managed storage. Valid location types: 'primary', 'secondary'. Default = 'primary'.", "length": 255, - "name": "tags", + "name": "locationtype", "required": false, - "type": "map" + "type": "string" + }, + { + "description": "The account of the snapshot. The account parameter must be used with the domainId parameter.", + "length": 255, + "name": "account", + "required": false, + "type": "string" } ], "related": "createSnapshotFromVMSnapshot,archiveSnapshot,revertSnapshot", "response": [ { - "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": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "valid location types are primary and secondary.", + "name": "locationtype", + "type": "string" }, { - "description": "name of the disk volume", - "name": "volumename", + "description": "display name of the os on volume", + "name": "osdisplayname", "type": "string" }, { - "description": "id of the availability zone", - "name": "zoneid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the list of resource tags associated", - "name": "tags", - "response": [ - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "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 name of the snapshot's account", + "name": "domain", + "type": "string" }, { - "description": "ID of the snapshot", - "name": "id", + "description": "id of the availability zone", + "name": "zoneid", "type": "string" }, { @@ -32041,48 +33104,48 @@ "type": "long" }, { - "description": "physical size of backedup snapshot on image store", - "name": "physicalsize", - "type": "long" - }, - { - "description": "display name of the os on volume", - "name": "osdisplayname", + "description": "valid types are hourly, daily, weekly, monthy, template, and none.", + "name": "intervaltype", "type": "string" }, { - "description": "indicates whether the underlying storage supports reverting the volume to this snapshot", - "name": "revertable", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the account associated with the snapshot", - "name": "account", + "description": "name of the snapshot", + "name": "name", "type": "string" }, { - "description": "the state of the snapshot. BackedUp means that snapshot is ready to be used; Creating - the snapshot is being allocated on the primary storage; BackingUp - the snapshot is being backed up on secondary storage", - "name": "state", - "type": "state" + "description": "name of the disk volume", + "name": "volumename", + "type": "string" }, { - "description": "the domain ID of the snapshot's account", - "name": "domainid", + "description": "id of the os on volume", + "name": "ostypeid", "type": "string" }, { - "description": "the project id of the snapshot", - "name": "projectid", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the type of the snapshot", + "name": "snapshottype", "type": "string" }, { - "description": "the domain name of the snapshot's account", - "name": "domain", + "description": "ID of the disk volume", + "name": "volumeid", "type": "string" }, { - "description": "the type of the snapshot", - "name": "snapshottype", + "description": "ID of the snapshot", + "name": "id", "type": "string" }, { @@ -32091,47 +33154,99 @@ "type": "string" }, { - "description": " the date the snapshot was created", - "name": "created", - "type": "date" + "description": "the domain ID of the snapshot's account", + "name": "domainid", + "type": "string" }, + {}, { - "description": "ID of the disk volume", - "name": "volumeid", - "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": "name of the snapshot", - "name": "name", + "description": "type of the disk volume", + "name": "volumetype", "type": "string" }, { - "description": "valid types are hourly, daily, weekly, monthy, template, and none.", - "name": "intervaltype", - "type": "string" + "description": " the date the snapshot was created", + "name": "created", + "type": "date" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the account associated with the snapshot", + "name": "account", "type": "string" }, { - "description": "valid location types are primary and secondary.", - "name": "locationtype", - "type": "string" + "description": "indicates whether the underlying storage supports reverting the volume to this snapshot", + "name": "revertable", + "type": "boolean" }, - {}, { - "description": "type of the disk volume", - "name": "volumetype", - "type": "string" + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + } + ], + "type": "set" }, { - "description": "id of the os on volume", - "name": "ostypeid", + "description": "the project id of the snapshot", + "name": "projectid", "type": "string" - } + }, + {} ] }, { @@ -32154,22 +33269,22 @@ "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 UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, + {}, {} ], "since": "4.2.0" @@ -32180,12 +33295,18 @@ "name": "listStoragePoolsMetrics", "params": [ { - "description": "the Zone ID for the storage pool", + "description": "", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" + }, + { + "description": "the name of the storage pool", + "length": 255, + "name": "name", + "required": false, + "type": "string" }, { "description": "the Pod ID for the storage pool", @@ -32196,49 +33317,42 @@ "type": "uuid" }, { - "description": "the IP address for the storage pool", + "description": "the storage pool path", "length": 255, - "name": "ipaddress", + "name": "path", "required": false, "type": "string" }, { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { - "description": "the storage pool path", + "description": "the ID of the storage pool", "length": 255, - "name": "path", + "name": "id", + "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "list storage pools belongig to the specific cluster", + "description": "the Zone ID for the storage pool", "length": 255, - "name": "clusterid", - "related": "addCluster,updateCluster", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, "type": "uuid" }, { - "description": "the name of the storage pool", + "description": "the IP address for the storage pool", "length": 255, - "name": "name", + "name": "ipaddress", "required": false, "type": "string" }, - { - "description": "the ID of the storage pool", - "length": 255, - "name": "id", - "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities", - "required": false, - "type": "uuid" - }, { "description": "the ID of the storage pool", "length": 255, @@ -32248,202 +33362,203 @@ "type": "string" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "pagesize", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { - "description": "", + "description": "list storage pools belongig to the specific cluster", "length": 255, - "name": "page", + "name": "clusterid", + "related": "addCluster,updateCluster", "required": false, - "type": "integer" + "type": "uuid" } ], "related": "", "response": [ { - "description": "the scope of the storage pool", - "name": "scope", - "type": "string" + "description": "storage usage notification threshold exceeded", + "name": "storageusagethreshold", + "type": "boolean" }, { - "description": "the host's currently used disk size", - "name": "disksizeused", + "description": "IOPS CloudStack can provision from this storage pool", + "name": "capacityiops", "type": "long" }, { - "description": "the name of the storage pool", - "name": "name", + "description": "the storage pool path", + "name": "path", "type": "string" }, { - "description": "storage usage disable threshold exceeded", - "name": "storageusagedisablethreshold", - "type": "boolean" - }, - { - "description": "the Zone ID of the storage pool", - "name": "zoneid", + "description": "the hypervisor type of the storage pool", + "name": "hypervisor", "type": "string" }, { - "description": "disk size in GiB", - "name": "disksizetotalgb", + "description": "the IP address of the storage pool", + "name": "ipaddress", "type": "string" }, { - "description": "storage allocated notification threshold exceeded", - "name": "storageallocatedthreshold", - "type": "boolean" - }, - { - "description": "the ID of the storage pool", - "name": "id", + "description": "the Pod name of the storage pool", + "name": "podname", "type": "string" }, { - "description": "the state of the storage pool", - "name": "state", - "type": "storagepoolstatus" + "description": "storage usage disable threshold exceeded", + "name": "storageusagedisablethreshold", + "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "disk size in GiB", + "name": "disksizetotalgb", "type": "string" }, { - "description": "disk size used in GiB", - "name": "disksizeusedgb", + "description": "the ID of the storage pool", + "name": "id", "type": "string" }, - {}, { - "description": "the tags for the storage pool", - "name": "tags", + "description": "disk size allocated in GiB", + "name": "disksizeallocatedgb", "type": "string" }, { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", - "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": "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 date and time the storage pool was created", + "name": "created", + "type": "date" }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + {}, { - "description": "the hypervisor type of the storage pool", - "name": "hypervisor", + "description": "the name of the storage pool", + "name": "name", "type": "string" }, { - "description": "storage usage notification threshold exceeded", - "name": "storageusagethreshold", + "description": "storage allocated disable threshold exceeded", + "name": "storageallocateddisablethreshold", "type": "boolean" }, + { + "description": "the host's currently used disk size", + "name": "disksizeused", + "type": "long" + }, + { + "description": "the host's currently allocated disk size", + "name": "disksizeallocated", + "type": "long" + }, { "description": "Storage provider for this pool", "name": "provider", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the Zone name of the storage pool", + "name": "zonename", + "type": "string" }, { - "description": "the overprovisionfactor for the storage pool", - "name": "overprovisionfactor", + "description": "the storage pool type", + "name": "type", "type": "string" }, { - "description": "the Pod ID of the storage pool", - "name": "podid", - "type": "string" + "description": "true if this pool is suitable to migrate a volume, false otherwise", + "name": "suitableformigration", + "type": "boolean" }, { - "description": "the date and time the storage pool was created", - "name": "created", - "type": "date" + "description": "the state of the storage pool", + "name": "state", + "type": "storagepoolstatus" }, - {}, { - "description": "the storage pool path", - "name": "path", - "type": "string" + "description": "total min IOPS currently in use by volumes", + "name": "allocatediops", + "type": "long" }, { - "description": "the Pod name of the storage pool", - "name": "podname", + "description": "storage allocated notification threshold exceeded", + "name": "storageallocatedthreshold", + "type": "boolean" + }, + { + "description": "the tags for the storage pool", + "name": "tags", "type": "string" }, { - "description": "the total disk size of the storage pool", - "name": "disksizetotal", - "type": "long" + "description": "the ID of the cluster for the storage pool", + "name": "clusterid", + "type": "string" }, { - "description": "the storage pool type", - "name": "type", + "description": "the Zone ID of the storage pool", + "name": "zoneid", "type": "string" }, { - "description": "storage allocated disable threshold exceeded", - "name": "storageallocateddisablethreshold", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, + {}, { - "description": "IOPS CloudStack can provision from this storage pool", - "name": "capacityiops", - "type": "long" + "description": "the scope of the storage pool", + "name": "scope", + "type": "string" }, { - "description": "disk size allocated in GiB", - "name": "disksizeallocatedgb", + "description": "the Pod ID of the storage pool", + "name": "podid", "type": "string" }, { - "description": "disk size unallocated in GiB", - "name": "disksizeunallocatedgb", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the IP address of the storage pool", - "name": "ipaddress", + "description": "disk size used in GiB", + "name": "disksizeusedgb", "type": "string" }, { - "description": "total min IOPS currently in use by volumes", - "name": "allocatediops", + "description": "the total disk size of the storage pool", + "name": "disksizetotal", "type": "long" }, { - "description": "the Zone name of the storage pool", - "name": "zonename", + "description": "disk size unallocated in GiB", + "name": "disksizeunallocatedgb", "type": "string" }, { - "description": "the storage pool capabilities", - "name": "storagecapabilities", - "type": "map" - }, - { - "description": "the ID of the cluster for the storage pool", - "name": "clusterid", + "description": "the name of the cluster for the storage pool", + "name": "clustername", "type": "string" } ], @@ -32465,28 +33580,28 @@ ], "related": "", "response": [ + { + "description": "details of the unmanage VM operation", + "name": "details", + "type": "string" + }, + { + "description": "result of the unmanage VM operation", + "name": "success", + "type": "boolean" + }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - { - "description": "result of the unmanage VM operation", - "name": "success", - "type": "boolean" - }, {}, - { - "description": "details of the unmanage VM operation", - "name": "details", - "type": "string" - } + {} ], "since": "4.15.0" }, @@ -32495,14 +33610,6 @@ "isasync": true, "name": "rebootRouter", "params": [ - { - "description": "Force reboot the router (Router is force Stopped and then Started)", - "length": 255, - "name": "forced", - "required": false, - "since": "4.16.0", - "type": "boolean" - }, { "description": "the ID of the router", "length": 255, @@ -32510,49 +33617,21 @@ "related": "destroyRouter,listRouters,rebootRouter,changeServiceForRouter,stopInternalLoadBalancerVM,listInternalLoadBalancerVMs", "required": true, "type": "uuid" + }, + { + "description": "Force reboot the router (Router is force Stopped and then Started)", + "length": 255, + "name": "forced", + "required": false, + "since": "4.16.0", + "type": "boolean" } ], "related": "destroyRouter,listRouters,changeServiceForRouter,stopInternalLoadBalancerVM,listInternalLoadBalancerVMs", "response": [ - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the id of the router", - "name": "id", - "type": "string" - }, - { - "description": "the gateway for the router", - "name": "gateway", - "type": "string" - }, - { - "description": "the template name for the router", - "name": "templatename", - "type": "string" - }, - { - "description": "the link local IP address for the router", - "name": "linklocalip", - "type": "string" - }, - { - "description": "the template ID for the router", - "name": "templateid", - "type": "string" - }, - { - "description": "the public IP address for the router", - "name": "publicip", - "type": "string" - }, { - "description": "the first DNS for the router", - "name": "dns1", + "description": "the guest MAC address for the router", + "name": "guestmacaddress", "type": "string" }, { @@ -32560,35 +33639,35 @@ "name": "projectid", "type": "string" }, + {}, { - "description": "the link local MAC address for the router", - "name": "linklocalmacaddress", + "description": "the guest netmask for the router", + "name": "guestnetmask", "type": "string" }, - {}, { - "description": "the guest MAC address for the router", - "name": "guestmacaddress", + "description": "the public IP address for the router", + "name": "publicip", "type": "string" }, { - "description": "the guest netmask for the router", - "name": "guestnetmask", + "description": "the hostname for the router", + "name": "hostname", "type": "string" }, { - "description": "true if the router template requires upgrader", - "name": "requiresupgrade", + "description": "if this router is an redundant virtual router", + "name": "isredundantrouter", "type": "boolean" }, { - "description": "role of the domain router", - "name": "role", + "description": "the version of template", + "name": "version", "type": "string" }, { - "description": "the ID of the corresponding guest network", - "name": "guestnetworkid", + "description": "the name of VPC the router belongs to", + "name": "vpcname", "type": "string" }, { @@ -32597,49 +33676,39 @@ "type": "string" }, { - "description": "the hostname for the router", - "name": "hostname", - "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 project name of the address", - "name": "project", + "description": "the first IPv6 DNS for the router", + "name": "ip6dns1", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the version of scripts", - "name": "scriptsversion", + "description": "the account associated with the router", + "name": "account", "type": "string" }, { - "description": "the name of VPC the router belongs to", - "name": "vpcname", + "description": "the Zone name for the router", + "name": "zonename", "type": "string" }, { - "description": "the domain ID associated with the router", - "name": "domainid", + "description": "the template name for the router", + "name": "templatename", "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 hypervisor on which the template runs", - "name": "hypervisor", - "type": "string" + "description": "true if the router template requires upgrader", + "name": "requiresupgrade", + "type": "boolean" }, { "description": "the name of the corresponding guest network", @@ -32652,19 +33721,19 @@ "type": "string" }, { - "description": "the network domain for the router", - "name": "networkdomain", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the version of template", - "name": "version", - "type": "string" + "description": "the state of the router", + "name": "state", + "type": "state" }, { - "description": "the host ID for the router", - "name": "hostid", - "type": "string" + "description": "true if any health checks had failed", + "name": "healthchecksfailed", + "type": "boolean" }, { "description": "the Pod name for the router", @@ -32672,54 +33741,42 @@ "type": "string" }, { - "description": "the link local netmask for the router", - "name": "linklocalnetmask", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "Last executed health check result for the router", - "name": "healthcheckresults", + "description": "the list of nics associated with the router", + "name": "nic", "response": [ { - "description": "the date this VPC was created", - "name": "lastupdated", - "type": "date" + "description": "the netmask of the nic", + "name": "netmask", + "type": "string" }, { - "description": "detailed response generated on running health check", - "name": "details", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "the name of the health check on the router", - "name": "checkname", + "description": "the name of the corresponding network", + "name": "networkname", "type": "string" }, { - "description": "result of the health check", - "name": "success", - "type": "boolean" + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" }, { - "description": "the type of the health check - basic or advanced", - "name": "checktype", - "type": "string" - } - ], - "type": "list" - }, - { - "description": "the list of nics associated with the router", - "name": "nic", - "response": [ - { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "the IPv6 address of network", + "name": "ip6address", "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" }, { @@ -32728,18 +33785,18 @@ "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the ID of the nic", + "name": "id", "type": "string" }, { - "description": "the netmask of the nic", - "name": "netmask", + "description": "the gateway of the nic", + "name": "gateway", "type": "string" }, { @@ -32748,43 +33805,48 @@ "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "true if nic is default, false otherwise", + "name": "macaddress", "type": "string" }, { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" }, { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" + "description": "the isolation uri of the nic", + "name": "isolationuri", + "type": "string" }, { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", + "type": "string" }, { - "description": "the type of the nic", - "name": "type", + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", "type": "string" }, { - "description": "the gateway of the nic", - "name": "gateway", + "description": "the ip address of the nic", + "name": "ipaddress", "type": "string" }, { - "description": "the IPv6 address of network", - "name": "ip6address", + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "type": "string" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "the ID of the corresponding network", + "name": "networkid", + "type": "string" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { @@ -32793,9 +33855,14 @@ "type": "boolean" }, { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" + "description": "the type of the nic", + "name": "type", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", + "type": "string" }, { "description": "device id for the network when plugged into the virtual machine", @@ -32803,62 +33870,84 @@ "type": "string" }, { - "description": "the ID of the nic", - "name": "id", + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", "type": "string" }, { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", - "type": "string" + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", "type": "string" }, { - "description": "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": "the state of redundant virtual router", + "name": "redundantstate", + "type": "string" + }, + { + "description": "the date and time the router was created", + "name": "created", + "type": "date" + }, + { + "description": "Last executed health check result for the router", + "name": "healthcheckresults", + "response": [ + { + "description": "result of the health check", + "name": "success", + "type": "boolean" }, { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "the name of the health check on the router", + "name": "checkname", "type": "string" }, { - "description": "the ip address of the nic", - "name": "ipaddress", - "type": "string" + "description": "the date this VPC was created", + "name": "lastupdated", + "type": "date" }, { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", + "description": "the type of the health check - basic or advanced", + "name": "checktype", "type": "string" }, { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "description": "detailed response generated on running health check", + "name": "details", "type": "string" } ], - "type": "set" + "type": "list" }, { - "description": "the account associated with the router", - "name": "account", + "description": "the gateway for the router", + "name": "gateway", "type": "string" }, { - "description": "the Zone name for the router", - "name": "zonename", + "description": "the id of the router", + "name": "id", "type": "string" }, { - "description": "the date and time the router was created", - "name": "created", - "type": "date" + "description": "the template ID for the router", + "name": "templateid", + "type": "string" }, { "description": "the guest IP address for the router", @@ -32866,68 +33955,104 @@ "type": "string" }, { - "description": "the name of the router", - "name": "name", + "description": "the first DNS for the router", + "name": "dns1", "type": "string" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "the second IPv6 DNS for the router", + "name": "ip6dns2", "type": "string" }, { - "description": "the first IPv6 DNS for the router", - "name": "ip6dns1", + "description": "the ID of the corresponding guest network", + "name": "guestnetworkid", + "type": "string" + }, + { + "description": "role of the domain router", + "name": "role", "type": "string" }, + { + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" + }, + {}, { "description": "the ID of the service offering of the virtual machine", "name": "serviceofferingid", "type": "string" }, + { + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", + "type": "string" + }, + { + "description": "the version of the code / software in the router", + "name": "softwareversion", + "type": "string" + }, + { + "description": "the version of scripts", + "name": "scriptsversion", + "type": "string" + }, { "description": "the public MAC address for the router", "name": "publicmacaddress", "type": "string" }, { - "description": "the second DNS for the router", - "name": "dns2", + "description": "the host ID for the router", + "name": "hostid", "type": "string" }, { - "description": "the state of the router", - "name": "state", - "type": "state" + "description": "the domain associated with the router", + "name": "domain", + "type": "string" }, { - "description": "VPC the router belongs to", - "name": "vpcid", + "description": "the network domain for the router", + "name": "networkdomain", "type": "string" }, { - "description": "the Pod ID for the router", - "name": "podid", + "description": "the ID of the corresponding link local network", + "name": "linklocalnetworkid", "type": "string" }, { - "description": "if this router is an redundant virtual router", - "name": "isredundantrouter", - "type": "boolean" + "description": "the domain ID associated with the router", + "name": "domainid", + "type": "string" }, { - "description": "the state of redundant virtual router", - "name": "redundantstate", + "description": "VPC the router belongs to", + "name": "vpcid", "type": "string" }, { - "description": "the second IPv6 DNS for the router", - "name": "ip6dns2", + "description": "the project name of the address", + "name": "project", "type": "string" }, { - "description": "the domain associated with the router", - "name": "domain", + "description": "the second DNS for the router", + "name": "dns2", + "type": "string" + }, + { + "description": "the Pod ID for the router", + "name": "podid", + "type": "string" + }, + { + "description": "the link local MAC address for the router", + "name": "linklocalmacaddress", "type": "string" }, { @@ -32936,9 +34061,14 @@ "type": "string" }, { - "description": "true if any health checks had failed", - "name": "healthchecksfailed", - "type": "boolean" + "description": "the name of the router", + "name": "name", + "type": "string" + }, + { + "description": "the link local IP address for the router", + "name": "linklocalip", + "type": "string" } ] }, @@ -32948,19 +34078,12 @@ "name": "listNics", "params": [ { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - }, - { - "description": "list nic of the specific vm's network", + "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", "length": 255, - "name": "networkid", - "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listF5LoadBalancerNetworks,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listSrxFirewallNetworks,listBrocadeVcsDeviceNetworks", + "name": "fordisplay", "required": false, - "type": "uuid" + "since": "4.4", + "type": "boolean" }, { "description": "", @@ -32970,20 +34093,19 @@ "type": "integer" }, { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "description": "the ID of the nic to to list IPs", "length": 255, - "name": "fordisplay", + "name": "nicid", + "related": "listNics", "required": false, - "since": "4.4", - "type": "boolean" + "type": "uuid" }, { - "description": "the ID of the vm", + "description": "List by keyword", "length": 255, - "name": "virtualmachineid", - "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance", - "required": true, - "type": "uuid" + "name": "keyword", + "required": false, + "type": "string" }, { "description": "", @@ -32993,41 +34115,43 @@ "type": "integer" }, { - "description": "the ID of the nic to to list IPs", + "description": "list nic of the specific vm's network", "length": 255, - "name": "nicid", - "related": "listNics", + "name": "networkid", + "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listSrxFirewallNetworks,listBrocadeVcsDeviceNetworks", "required": false, "type": "uuid" + }, + { + "description": "the ID of the vm", + "length": 255, + "name": "virtualmachineid", + "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,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 IPv6 address of network", - "name": "ip6address", + "description": "the traffic type of the nic", + "name": "traffictype", "type": "string" }, { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" - }, - { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" + "description": "the ID of the corresponding network", + "name": "networkid", + "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 UUID of the latest async job acting on this object", @@ -33035,96 +34159,122 @@ "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "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 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": "Type of adapter if available", + "name": "adaptertype", + "type": "string" }, { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "the gateway of the nic", + "name": "gateway", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", "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": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "the IPv6 address of network", + "name": "ip6address", "type": "string" }, { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" + }, + { + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "type": "string" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", "type": "string" }, { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "true if nic is default, false otherwise", + "name": "macaddress", "type": "string" }, + {}, { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "the gateway of the nic", - "name": "gateway", + "description": "the name of the corresponding network", + "name": "networkname", "type": "string" }, { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", "type": "string" }, + { + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, { "description": "the ip address of the nic", "name": "ipaddress", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the type of the nic", + "name": "type", "type": "string" }, { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "the netmask of the nic", + "name": "netmask", "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": "id", @@ -33134,16 +34284,6 @@ "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" } ] }, @@ -33160,11 +34300,12 @@ "type": "string" }, { - "description": "an optional account for the ssh key. Must be used with domainId.", + "description": "an optional project for the ssh key", "length": 255, - "name": "account", + "name": "projectid", + "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", "required": false, - "type": "string" + "type": "uuid" }, { "description": "an optional domainId for the ssh key. If the account parameter is used, domainId must also be used.", @@ -33175,34 +34316,29 @@ "type": "uuid" }, { - "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,listProjects,suspendProject,updateProject", + "name": "account", "required": false, - "type": "uuid" + "type": "string" } ], "related": "", "response": [ + {}, { "description": "Private key", "name": "privatekey", "type": "string" }, { - "description": "the owner of the keypair", - "name": "account", - "type": "string" - }, - { - "description": "Fingerprint of the public key", - "name": "fingerprint", + "description": "the domain id of the keypair owner", + "name": "domainid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the domain name of the keypair owner", + "name": "domain", "type": "string" }, { @@ -33210,74 +34346,38 @@ "name": "hasannotations", "type": "boolean" }, - { - "description": "ID of the ssh keypair", - "name": "id", - "type": "string" - }, - { - "description": "the domain id of the keypair owner", - "name": "domainid", - "type": "string" - }, - {}, { "description": "Name of the keypair", "name": "name", "type": "string" }, - { - "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": "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": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - {}, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the owner of the keypair", + "name": "account", + "type": "string" }, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "ID of the ssh keypair", + "name": "id", + "type": "string" }, + {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "Fingerprint of the public key", + "name": "fingerprint", "type": "string" } - ], - "since": "4.14.0" + ] }, { "description": "Creates an instant snapshot of a volume from existing vm snapshot.", @@ -33288,17 +34388,10 @@ "description": "The ID of the disk volume", "length": 255, "name": "volumeid", - "related": "attachVolume,createVolume,updateVolume,listVolumes,migrateVolume,resizeVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", + "related": "attachVolume,createVolume,updateVolume,listVolumes,migrateVolume,resizeVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", "required": true, "type": "uuid" }, - { - "description": "the name of the snapshot", - "length": 255, - "name": "name", - "required": false, - "type": "string" - }, { "description": "The ID of the VM snapshot", "length": 255, @@ -33306,58 +34399,61 @@ "related": "listVMSnapshot,createVMSnapshot", "required": true, "type": "uuid" + }, + { + "description": "the name of the snapshot", + "length": 255, + "name": "name", + "required": false, + "type": "string" } ], "related": "archiveSnapshot,revertSnapshot", "response": [ { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the project id of the snapshot", + "name": "projectid", "type": "string" }, { - "description": "display name of the os on volume", - "name": "osdisplayname", + "description": "id of the os on volume", + "name": "ostypeid", "type": "string" }, + {}, { "description": "id of the availability zone", "name": "zoneid", "type": "string" }, { - "description": "ID of the snapshot", - "name": "id", + "description": "the domain name of the snapshot's account", + "name": "domain", "type": "string" }, - { - "description": " the date the snapshot was created", - "name": "created", - "type": "date" - }, { "description": "virtual size of backedup snapshot on image store", "name": "virtualsize", "type": "long" }, { - "description": "the domain name of the snapshot's account", - "name": "domain", - "type": "string" + "description": "the state of the snapshot. BackedUp means that snapshot is ready to be used; Creating - the snapshot is being allocated on the primary storage; BackingUp - the snapshot is being backed up on secondary storage", + "name": "state", + "type": "state" }, { - "description": "name of the snapshot", - "name": "name", - "type": "string" + "description": "physical size of backedup snapshot on image store", + "name": "physicalsize", + "type": "long" }, { - "description": "the account associated with the snapshot", - "name": "account", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the type of the snapshot", - "name": "snapshottype", + "description": "name of the disk volume", + "name": "volumename", "type": "string" }, { @@ -33365,14 +34461,34 @@ "name": "volumeid", "type": "string" }, + { + "description": "the domain ID of the snapshot's account", + "name": "domainid", + "type": "string" + }, + { + "description": "the account associated with the snapshot", + "name": "account", + "type": "string" + }, { "description": "type of the disk volume", "name": "volumetype", "type": "string" }, { - "description": "the project name of the snapshot", - "name": "project", + "description": "display name of the os on volume", + "name": "osdisplayname", + "type": "string" + }, + { + "description": "indicates whether the underlying storage supports reverting the volume to this snapshot", + "name": "revertable", + "type": "boolean" + }, + { + "description": "valid location types are primary and secondary.", + "name": "locationtype", "type": "string" }, { @@ -33380,28 +34496,28 @@ "name": "tags", "response": [ { - "description": "id of the resource", - "name": "resourceid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "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": "customer associated with the tag", - "name": "customer", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { @@ -33410,83 +34526,67 @@ "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "tag value", + "name": "value", "type": "string" } ], "type": "set" }, - { - "description": "physical size of backedup snapshot on image store", - "name": "physicalsize", - "type": "long" - }, - { - "description": "the state of the snapshot. BackedUp means that snapshot is ready to be used; Creating - the snapshot is being allocated on the primary storage; BackingUp - the snapshot is being backed up on secondary storage", - "name": "state", - "type": "state" - }, - {}, - { - "description": "id of the os on volume", - "name": "ostypeid", - "type": "string" - }, { "description": "valid types are hourly, daily, weekly, monthy, template, and none.", "name": "intervaltype", "type": "string" }, { - "description": "indicates whether the underlying storage supports reverting the volume to this snapshot", - "name": "revertable", - "type": "boolean" + "description": "ID of the snapshot", + "name": "id", + "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, { - "description": "valid location types are primary and secondary.", - "name": "locationtype", - "type": "string" + "description": " the date the snapshot was created", + "name": "created", + "type": "date" }, { - "description": "the domain ID of the snapshot's account", - "name": "domainid", + "description": "the type of the snapshot", + "name": "snapshottype", "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", - "name": "jobstatus", - "type": "integer" + "description": "the project name of the snapshot", + "name": "project", + "type": "string" }, { - "description": "name of the disk volume", - "name": "volumename", + "description": "name of the snapshot", + "name": "name", "type": "string" } ], @@ -33498,19 +34598,19 @@ "name": "authorizeSecurityGroupEgress", "params": [ { - "description": "an optional project of the security group", + "description": "The ID of the security group. Mutually exclusive with securityGroupName parameter", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", + "name": "securitygroupid", + "related": "createSecurityGroup,updateSecurityGroup", "required": false, "type": "uuid" }, { - "description": "user to security group mapping", + "description": "TCP is default. UDP is the other supported protocol", "length": 255, - "name": "usersecuritygrouplist", + "name": "protocol", "required": false, - "type": "map" + "type": "string" }, { "description": "type of the icmp message being sent", @@ -33520,55 +34620,48 @@ "type": "integer" }, { - "description": "start port for this egress rule", - "length": 255, - "name": "startport", - "required": false, - "type": "integer" - }, - { - "description": "an optional account for the security group. Must be used with domainId.", + "description": "an optional project of the security group", "length": 255, - "name": "account", + "name": "projectid", + "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "an optional domainId for the security group. If the account parameter is used, domainId must also be used.", + "description": "end port for this egress rule", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains", + "name": "endport", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "TCP is default. UDP is the other supported protocol", + "description": "user to security group mapping", "length": 255, - "name": "protocol", + "name": "usersecuritygrouplist", "required": false, - "type": "string" + "type": "map" }, { - "description": "error code for this icmp message", + "description": "start port for this egress rule", "length": 255, - "name": "icmpcode", + "name": "startport", "required": false, "type": "integer" }, { - "description": "end port for this egress rule", + "description": "an optional domainId for the security group. If the account parameter is used, domainId must also be used.", "length": 255, - "name": "endport", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "The ID of the security group. Mutually exclusive with securityGroupName parameter", + "description": "The name of the security group. Mutually exclusive with securityGroupId parameter", "length": 255, - "name": "securitygroupid", - "related": "createSecurityGroup,updateSecurityGroup", + "name": "securitygroupname", "required": false, - "type": "uuid" + "type": "string" }, { "description": "the cidr list associated. Multiple entries must be separated by a single comma character (,).", @@ -33578,18 +34671,26 @@ "type": "list" }, { - "description": "The name of the security group. Mutually exclusive with securityGroupId parameter", + "description": "error code for this icmp message", "length": 255, - "name": "securitygroupname", + "name": "icmpcode", + "required": false, + "type": "integer" + }, + { + "description": "an optional account for the security group. Must be used with domainId.", + "length": 255, + "name": "account", "required": false, "type": "string" } ], "related": "authorizeSecurityGroupIngress", "response": [ + {}, { - "description": "the ending IP of the security group rule ", - "name": "endport", + "description": "the type of the ICMP message response", + "name": "icmptype", "type": "integer" }, { @@ -33597,50 +34698,48 @@ "name": "jobstatus", "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 UUID of the latest async job acting on this object", - "name": "jobid", + "description": "account owning the security group rule", + "name": "account", "type": "string" }, - {}, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, - { - "description": "resource type", - "name": "resourcetype", + { + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { @@ -33649,56 +34748,57 @@ "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": "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" } ], "type": "set" }, { - "description": "the type of the ICMP message response", - "name": "icmptype", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", "type": "integer" }, { - "description": "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 CIDR notation for the base IP address of the security group rule", - "name": "cidr", + "description": "the id of the security group rule", + "name": "ruleid", "type": "string" }, { - "description": "the id of the security group rule", - "name": "ruleid", + "description": "the protocol of the security group rule", + "name": "protocol", "type": "string" }, { - "description": "the starting IP of the security group rule", - "name": "startport", + "description": "the code for the ICMP message response", + "name": "icmpcode", "type": "integer" } ], @@ -33710,32 +34810,32 @@ "name": "listStoragePools", "params": [ { - "description": "list storage pools belongig to the specific cluster", + "description": "List by keyword", "length": 255, - "name": "clusterid", - "related": "addCluster,updateCluster", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "", + "description": "the Zone ID for the storage pool", "length": 255, - "name": "pagesize", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, - "type": "integer" + "type": "uuid" }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, { - "description": "the ID of the storage pool", + "description": "the Pod ID for the storage pool", "length": 255, - "name": "id", - "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities", + "name": "podid", + "related": "updatePod,createManagementNetworkIpRange", "required": false, "type": "uuid" }, @@ -33747,47 +34847,47 @@ "type": "string" }, { - "description": "the Zone ID for the storage pool", + "description": "list storage pools belongig to the specific cluster", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "clusterid", + "related": "addCluster,updateCluster", "required": false, "type": "uuid" }, { - "description": "the ID of the storage pool", + "description": "the storage pool path", "length": 255, - "name": "scope", - "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities", + "name": "path", "required": false, "type": "string" }, { - "description": "the Pod ID for the storage pool", + "description": "the ID of the storage pool", "length": 255, - "name": "podid", - "related": "updatePod,createManagementNetworkIpRange", + "name": "id", + "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities", "required": false, "type": "uuid" }, { - "description": "List by keyword", + "description": "the name of the storage pool", "length": 255, - "name": "keyword", + "name": "name", "required": false, "type": "string" }, { - "description": "the storage pool path", + "description": "", "length": 255, - "name": "path", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { - "description": "the name of the storage pool", + "description": "the ID of the storage pool", "length": 255, - "name": "name", + "name": "scope", + "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities", "required": false, "type": "string" } @@ -33800,30 +34900,19 @@ "type": "string" }, { - "description": "total min IOPS currently in use by volumes", - "name": "allocatediops", - "type": "long" - }, - { - "description": "the overprovisionfactor for the storage pool", - "name": "overprovisionfactor", - "type": "string" - }, - { - "description": "the Pod ID of the storage pool", - "name": "podid", + "description": "the Zone name of the storage pool", + "name": "zonename", "type": "string" }, - {}, { - "description": "the name of the cluster for the storage pool", - "name": "clustername", + "description": "the ID of the storage pool", + "name": "id", "type": "string" }, { - "description": "the Zone name of the storage pool", - "name": "zonename", - "type": "string" + "description": "the host's currently used disk size", + "name": "disksizeused", + "type": "long" }, { "description": "the date and time the storage pool was created", @@ -33831,44 +34920,35 @@ "type": "date" }, { - "description": "the ID of the storage pool", - "name": "id", - "type": "string" - }, - { - "description": "true if this pool is suitable to migrate a volume, false otherwise", - "name": "suitableformigration", - "type": "boolean" + "description": "total min IOPS currently in use by volumes", + "name": "allocatediops", + "type": "long" }, {}, { - "description": "the name of the storage pool", - "name": "name", + "description": "the overprovisionfactor for the storage pool", + "name": "overprovisionfactor", "type": "string" }, { - "description": "the Pod name of the storage pool", - "name": "podname", + "description": "the Zone ID of the storage pool", + "name": "zoneid", "type": "string" }, { - "description": "IOPS CloudStack can provision from this storage pool", - "name": "capacityiops", - "type": "long" - }, - { - "description": "the storage pool type", - "name": "type", + "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 host's currently allocated disk size", + "name": "disksizeallocated", + "type": "long" }, { - "description": "the Zone ID of the storage pool", - "name": "zoneid", + "description": "the Pod ID of the storage pool", + "name": "podid", "type": "string" }, { @@ -33877,24 +34957,44 @@ "type": "string" }, { - "description": "the host's currently used disk size", - "name": "disksizeused", + "description": "IOPS CloudStack can provision from this storage pool", + "name": "capacityiops", "type": "long" }, + { + "description": "the state of the storage pool", + "name": "state", + "type": "storagepoolstatus" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the name of the cluster for the storage pool", + "name": "clustername", + "type": "string" + }, { "description": "the hypervisor type of the storage pool", "name": "hypervisor", "type": "string" }, { - "description": "the ID of the cluster for the storage pool", - "name": "clusterid", + "description": "the name of the storage pool", + "name": "name", "type": "string" }, { - "description": "the storage pool capabilities", - "name": "storagecapabilities", - "type": "map" + "description": "Storage provider for this pool", + "name": "provider", + "type": "string" + }, + { + "description": "the storage pool type", + "name": "type", + "type": "string" }, { "description": "the total disk size of the storage pool", @@ -33902,29 +35002,29 @@ "type": "long" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "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": "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 state of the storage pool", - "name": "state", - "type": "storagepoolstatus" + "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 storage pool capabilities", + "name": "storagecapabilities", + "type": "map" }, { "description": "the tags for the storage pool", @@ -33944,19 +35044,12 @@ "name": "updateHypervisorCapabilities", "params": [ { - "description": "the max number of Guest VMs per host for this hypervisor.", - "length": 255, - "name": "maxguestslimit", - "required": false, - "type": "long" - }, - { - "description": "ID of the hypervisor capability", + "description": "set true to enable storage motion support for this hypervisor", "length": 255, - "name": "id", - "related": "listHypervisorCapabilities,updateHypervisorCapabilities", + "name": "storagemotionenabled", "required": false, - "type": "uuid" + "since": "4.16.0", + "type": "boolean" }, { "description": "the maximum number of the hypervisor hosts per cluster ", @@ -33982,12 +35075,19 @@ "type": "boolean" }, { - "description": "set true to enable storage motion support for this hypervisor", + "description": "the max number of Guest VMs per host for this hypervisor.", "length": 255, - "name": "storagemotionenabled", + "name": "maxguestslimit", "required": false, - "since": "4.16.0", - "type": "boolean" + "type": "long" + }, + { + "description": "ID of the hypervisor capability", + "length": 255, + "name": "id", + "related": "listHypervisorCapabilities,updateHypervisorCapabilities", + "required": false, + "type": "uuid" }, { "description": "the maximum number of Data Volumes that can be attached to a VM for this hypervisor.", @@ -34001,31 +35101,27 @@ "related": "listHypervisorCapabilities", "response": [ { - "description": "the maximum number of guest vms recommended for this hypervisor", - "name": "maxguestslimit", - "type": "long" + "description": "the maximum number of Data Volumes that can be attached for this hypervisor", + "name": "maxdatavolumeslimit", + "type": "integer" + }, + { + "description": "the hypervisor version", + "name": "hypervisorversion", + "type": "string" }, + {}, + {}, { "description": "the hypervisor type", "name": "hypervisor", "type": "hypervisortype" }, { - "description": "true if security group is supported", - "name": "securitygroupenabled", - "type": "boolean" - }, - {}, - { - "description": "the maximum number of Data Volumes that can be attached for this hypervisor", - "name": "maxdatavolumeslimit", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, - { - "description": "the ID of the hypervisor capabilities row", - "name": "id", - "type": "string" - }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", @@ -34036,26 +35132,30 @@ "name": "vmsnapshotenabled", "type": "boolean" }, - {}, { - "description": "true if storage motion is supported", - "name": "storagemotionenabled", + "description": "true if security group is supported", + "name": "securitygroupenabled", "type": "boolean" }, { - "description": "the hypervisor version", - "name": "hypervisorversion", - "type": "string" + "description": "the maximum number of Hosts per cluster for this hypervisor", + "name": "maxhostspercluster", + "type": "integer" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "true if storage motion is supported", + "name": "storagemotionenabled", + "type": "boolean" }, { - "description": "the maximum number of Hosts per cluster for this hypervisor", - "name": "maxhostspercluster", - "type": "integer" + "description": "the maximum number of guest vms recommended for this hypervisor", + "name": "maxguestslimit", + "type": "long" + }, + { + "description": "the ID of the hypervisor capabilities row", + "name": "id", + "type": "string" } ], "since": "3.0.0" @@ -34066,11 +35166,18 @@ "name": "findHostsForMigration", "params": [ { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" }, { "description": "find hosts to which this VM can be migrated and flag the hosts with enough CPU/RAM to host the VM", @@ -34081,45 +35188,28 @@ "type": "uuid" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, - { - "description": "", + "description": "List by keyword", "length": 255, - "name": "pagesize", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" } ], "related": "", "response": [ { - "description": "true if the host is disconnected. False otherwise.", - "name": "disconnected", - "type": "date" + "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", + "name": "memorytotal", + "type": "long" }, { - "description": "the OS category name of the host", - "name": "oscategoryname", + "description": "capabilities of the host", + "name": "capabilities", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the date and time the host was created", - "name": "created", - "type": "date" - }, - { - "description": "the ID of the host", - "name": "id", + "description": "the amount of the host's memory currently allocated", + "name": "memoryallocated", "type": "string" }, { @@ -34128,186 +35218,216 @@ "type": "string" }, { - "description": "the host type", - "name": "type", - "type": "type" + "description": "the host's currently allocated disk size", + "name": "disksizeallocated", + "type": "long" }, { - "description": "the host hypervisor", - "name": "hypervisor", - "type": "hypervisortype" + "description": "the management server ID of the host", + "name": "managementserverid", + "type": "long" }, { - "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor ", - "name": "cpuwithoverprovisioning", + "description": "the OS category ID of the host", + "name": "oscategoryid", "type": "string" }, { - "description": "true if migrating a vm to this host requires storage motion, false otherwise", - "name": "requiresStorageMotion", - "type": "boolean" + "description": "events available for the host", + "name": "events", + "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 this host is suitable(has enough capacity and satisfies all conditions like hosttags, max guests vm limit etc) to migrate a VM to it , false otherwise", + "name": "suitableformigration", "type": "boolean" }, + { + "description": "the Pod name of the host", + "name": "podname", + "type": "string" + }, { "description": "the cluster ID of the host", "name": "clusterid", "type": "string" }, { - "description": "capabilities of the host", - "name": "capabilities", + "description": "the host version", + "name": "version", "type": "string" }, { - "description": "comma-separated list of tags for the host", - "name": "hosttags", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", - "name": "memorytotal", - "type": "long" + "description": "the CPU number of the host", + "name": "cpunumber", + "type": "integer" }, { - "description": "the IP address of the host", - "name": "ipaddress", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {}, + { + "description": "the ID of the host", + "name": "id", "type": "string" }, { - "description": "the amount of the host's CPU currently allocated in MHz", - "name": "cpuallocatedvalue", - "type": "long" + "description": "the date and time the host was last pinged", + "name": "lastpinged", + "type": "date" }, { - "description": "the amount of the host's memory currently used", - "name": "memoryused", - "type": "long" + "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor ", + "name": "cpuwithoverprovisioning", + "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 hypervisor version", + "name": "hypervisorversion", + "type": "string" }, { - "description": "the amount of the host's CPU currently used", - "name": "cpuused", + "description": "the state of the host", + "name": "state", + "type": "status" + }, + { + "description": "the date and time the host was removed", + "name": "removed", + "type": "date" + }, + { + "description": "the resource state of the host", + "name": "resourcestate", "type": "string" }, { - "description": "the Zone name of the host", - "name": "zonename", + "description": "the Zone ID of the host", + "name": "zoneid", "type": "string" }, { - "description": "the total disk size of the host", - "name": "disksizetotal", + "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 host version", - "name": "version", - "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 after applying the cpu.overprovisioning.factor", - "name": "cpuallocatedwithoverprovisioning", + "description": "the OS category name of the host", + "name": "oscategoryname", "type": "string" }, - {}, { - "description": "the Zone ID of the host", - "name": "zoneid", + "description": "the IP address of the host", + "name": "ipaddress", "type": "string" }, + {}, { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", + "description": "the amount of the host's memory currently used", + "name": "memoryused", "type": "long" }, - {}, { - "description": "the amount of the host's memory currently allocated in percentage", - "name": "memoryallocatedpercentage", + "description": "the cluster type of the cluster that host belongs to", + "name": "clustertype", "type": "string" }, { - "description": "the CPU number of the host", - "name": "cpunumber", - "type": "integer" + "description": "the name of the host", + "name": "name", + "type": "string" }, { - "description": "the state of the host", - "name": "state", - "type": "status" + "description": "true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise", + "name": "hasenoughcapacity", + "type": "boolean" }, { - "description": "the management server ID of the host", - "name": "managementserverid", - "type": "long" + "description": "true if the host is disconnected. False otherwise.", + "name": "disconnected", + "type": "date" + }, + { + "description": "the host hypervisor", + "name": "hypervisor", + "type": "hypervisortype" }, { - "description": "the hypervisor version", - "name": "hypervisorversion", - "type": "string" + "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", + "description": "the cluster name of the host", + "name": "clustername", "type": "string" }, { - "description": "the amount of the host's CPU currently allocated in percentage", - "name": "cpuallocatedpercentage", + "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", + "name": "cpuallocatedwithoverprovisioning", "type": "string" }, { - "description": "the Pod ID of the host", - "name": "podid", - "type": "string" + "description": "true if migrating a vm to this host requires storage motion, false otherwise", + "name": "requiresStorageMotion", + "type": "boolean" }, { - "description": "events available for the host", - "name": "events", - "type": "string" + "description": "the total disk size of the host", + "name": "disksizetotal", + "type": "long" }, { - "description": "the outgoing network traffic on the host", - "name": "networkkbswrite", + "description": "the cpu average load on the host", + "name": "averageload", "type": "long" }, { - "description": "the cluster type of the cluster that host belongs to", - "name": "clustertype", - "type": "string" + "description": "the host type", + "name": "type", + "type": "type" }, { - "description": "the name of the host", - "name": "name", - "type": "string" + "description": "true if local storage is active, false otherwise", + "name": "islocalstorageactive", + "type": "boolean" }, { - "description": "the resource state of the host", - "name": "resourcestate", + "description": "the amount of the host's CPU currently allocated in percentage", + "name": "cpuallocatedpercentage", "type": "string" }, { - "description": "the OS category ID of the host", - "name": "oscategoryid", + "description": "the Pod ID of the host", + "name": "podid", "type": "string" }, { - "description": "the date and time the host was last pinged", - "name": "lastpinged", - "type": "date" + "description": "the amount of the host's CPU currently used", + "name": "cpuused", + "type": "string" }, { - "description": "the CPU speed of the host", - "name": "cpuspeed", - "type": "long" + "description": "the Zone name of the host", + "name": "zonename", + "type": "string" }, { "description": "the amount of the host's memory currently allocated in bytes", @@ -34315,49 +35435,29 @@ "type": "long" }, { - "description": "the cpu average load on the host", - "name": "averageload", + "description": "the amount of the host's CPU currently allocated in MHz", + "name": "cpuallocatedvalue", "type": "long" }, { - "description": "the amount of the host's memory currently allocated", - "name": "memoryallocated", + "description": "the amount of the host's memory currently allocated in percentage", + "name": "memoryallocatedpercentage", "type": "string" }, - { - "description": "the date and time the host was removed", - "name": "removed", - "type": "date" - }, - { - "description": "true if this host is suitable(has enough capacity and satisfies all conditions like hosttags, max guests vm limit etc) to migrate a VM to it , false otherwise", - "name": "suitableformigration", - "type": "boolean" - }, { "description": "the incoming network traffic on the host", "name": "networkkbsread", "type": "long" }, { - "description": "the cluster name of the host", - "name": "clustername", - "type": "string" - }, - { - "description": "the Pod name of the host", - "name": "podname", - "type": "string" + "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise", + "name": "hahost", + "type": "boolean" }, { - "description": "the amount of the host's memory after applying the mem.overprovisioning.factor ", - "name": "memorywithoverprovisioning", + "description": "comma-separated list of tags for the host", + "name": "hosttags", "type": "string" - }, - { - "description": "true if local storage is active, false otherwise", - "name": "islocalstorageactive", - "type": "boolean" } ] }, @@ -34377,24 +35477,29 @@ ], "related": "listCiscoNexusVSMs,disableCiscoNexusVSM", "response": [ + { + "description": "device state", + "name": "vsmdevicestate", + "type": "string" + }, + { + "description": "the management IP address of the external Cisco Nexus 1000v Virtual Supervisor Module", + "name": "ipaddress", + "type": "string" + }, { "description": "The VSM is a switch supervisor. This is the VSM's switch domain id", "name": "vsmdomainid", "type": "string" }, { - "description": "device state", + "description": "The Device State (Enabled/Disabled) of the VSM", "name": "vsmdevicestate", "type": "string" }, { - "description": "control vlan id of the VSM", - "name": "vsmctrlvlanid", - "type": "int" - }, - { - "description": "The Config State (Primary/Standby) of the VSM", - "name": "vsmconfigstate", + "description": "The mode of the VSM (standalone/HA)", + "name": "vsmconfigmode", "type": "string" }, { @@ -34402,36 +35507,36 @@ "name": "vsmpktvlanid", "type": "int" }, - {}, - {}, { "description": "device id of the Cisco N1KV VSM device", "name": "vsmdeviceid", "type": "string" }, { - "description": "The mode of the VSM (standalone/HA)", - "name": "vsmconfigmode", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the management IP address of the external Cisco Nexus 1000v Virtual Supervisor Module", - "name": "ipaddress", - "type": "string" + "description": "control vlan id of the VSM", + "name": "vsmctrlvlanid", + "type": "int" }, { - "description": "device name", - "name": "vsmdevicename", - "type": "string" + "description": "storage vlan id of the VSM", + "name": "vsmstoragevlanid", + "type": "int" }, + {}, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "management vlan id of the VSM", + "name": "vsmmgmtvlanid", "type": "string" }, { - "description": "The Device State (Enabled/Disabled) of the VSM", - "name": "vsmdevicestate", + "description": "device name", + "name": "vsmdevicename", "type": "string" }, { @@ -34440,13 +35545,8 @@ "type": "integer" }, { - "description": "storage vlan id of the VSM", - "name": "vsmstoragevlanid", - "type": "int" - }, - { - "description": "management vlan id of the VSM", - "name": "vsmmgmtvlanid", + "description": "The Config State (Primary/Standby) of the VSM", + "name": "vsmconfigstate", "type": "string" } ] @@ -34457,19 +35557,20 @@ "name": "dedicateGuestVlanRange", "params": [ { - "description": "physical network ID of the vlan", + "description": "domain ID of the account owning a VLAN", "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork", - "required": true, + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains", + "required": false, "type": "uuid" }, { - "description": "guest vlan range to be dedicated", + "description": "physical network ID of the vlan", "length": 255, - "name": "vlanrange", + "name": "physicalnetworkid", + "related": "createPhysicalNetwork", "required": true, - "type": "string" + "type": "uuid" }, { "description": "project who will own the VLAN", @@ -34480,18 +35581,17 @@ "type": "uuid" }, { - "description": "domain ID of the account owning a VLAN", + "description": "account who will own the VLAN", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains", + "name": "account", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "account who will own the VLAN", + "description": "guest vlan range to be dedicated", "length": 255, - "name": "account", - "required": false, + "name": "vlanrange", + "required": true, "type": "string" } ], @@ -34503,9 +35603,9 @@ "type": "string" }, { - "description": "the ID of the guest VLAN range", - "name": "id", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "the zone of the guest vlan range", @@ -34517,23 +35617,18 @@ "name": "domainid", "type": "string" }, - {}, - { - "description": "the project id of the guest vlan range", - "name": "projectid", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "the physical network of the guest vlan range", "name": "physicalnetworkid", "type": "long" }, {}, + { + "description": "the project name of the guest vlan range", + "name": "project", + "type": "string" + }, + {}, { "description": "the domain name of the guest VLAN range", "name": "domain", @@ -34550,8 +35645,13 @@ "type": "string" }, { - "description": "the project name of the guest vlan range", - "name": "project", + "description": "the ID of the guest VLAN range", + "name": "id", + "type": "string" + }, + { + "description": "the project id of the guest vlan range", + "name": "projectid", "type": "string" } ] @@ -34569,18 +35669,17 @@ "type": "string" }, { - "description": "Virtual Machine ID", + "description": "Mac Address for the new network", "length": 255, - "name": "virtualmachineid", - "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance", - "required": true, - "type": "uuid" + "name": "macaddress", + "required": false, + "type": "string" }, { - "description": "Network ID", + "description": "Virtual Machine ID", "length": 255, - "name": "networkid", - "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listF5LoadBalancerNetworks,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listSrxFirewallNetworks,listBrocadeVcsDeviceNetworks", + "name": "virtualmachineid", + "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance", "required": true, "type": "uuid" }, @@ -34592,64 +35691,34 @@ "type": "map" }, { - "description": "Mac Address for the new network", + "description": "Network ID", "length": 255, - "name": "macaddress", - "required": false, - "type": "string" + "name": "networkid", + "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listSrxFirewallNetworks,listBrocadeVcsDeviceNetworks", + "required": true, + "type": "uuid" } ], "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance", "response": [ { - "description": "the memory used by the vm", - "name": "memorykbs", - "type": "long" - }, - { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", - "type": "string" - }, - { - "description": "the group ID of the virtual machine", - "name": "groupid", - "type": "string" - }, - { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", - "type": "boolean" - }, - {}, - { - "description": "ssh key-pair", - "name": "keypair", - "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", + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", "type": "string" }, { - "description": "the ID of the virtual machine", - "name": "id", + "description": "the user's name who deployed the virtual machine", + "name": "username", "type": "string" }, { - "description": "OS name of the vm", - "name": "osdisplayname", + "description": "the group name of the virtual machine", + "name": "group", "type": "string" }, { - "description": "the pool type of the virtual machine", - "name": "pooltype", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, { @@ -34658,273 +35727,250 @@ "type": "integer" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", - "type": "string" - }, - { - "description": "the password (if exists) of the virtual machine", - "name": "password", - "type": "string" - }, - {}, - { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" - }, - { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" - }, - { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", - "type": "boolean" - }, - { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", - "type": "string" - }, - { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" - }, - { - "description": "the state of the virtual machine", - "name": "state", - "type": "string" - }, - { - "description": "the outgoing network traffic on the host", - "name": "networkkbswrite", + "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": "Guest vm Boot Type", - "name": "boottype", - "type": "string" - }, - { - "description": "the name of the virtual machine", - "name": "name", - "type": "string" - }, - { - "description": "the group name of the virtual machine", - "name": "group", - "type": "string" - }, - { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", - "type": "string" + "description": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", + "response": [ + { + "description": "the ID of the affinity group", + "name": "id", + "type": "string" + }, + { + "description": "the description of the affinity group", + "name": "description", + "type": "string" + }, + { + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" + }, + { + "description": "the type of the affinity group", + "name": "type", + "type": "string" + }, + { + "description": "the domain ID of the affinity group", + "name": "domainid", + "type": "string" + }, + { + "description": "the project ID of the affinity group", + "name": "projectid", + "type": "string" + }, + { + "description": "the domain name of the affinity group", + "name": "domain", + "type": "string" + }, + { + "description": "the name of the affinity group", + "name": "name", + "type": "string" + }, + { + "description": "the project name of the affinity group", + "name": "project", + "type": "string" + }, + { + "description": "the account owning the affinity group", + "name": "account", + "type": "string" + } + ], + "type": "set" }, { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", + "description": "the name of the disk offering of the virtual machine", + "name": "diskofferingname", "type": "string" }, { - "description": "the ID of the disk offering of the virtual machine", - "name": "diskofferingid", - "type": "string" + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", + "type": "boolean" }, { - "description": "the 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": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", "type": "string" }, {}, { - "description": "the vgpu type used by the virtual machine", - "name": "vgpu", - "type": "string" - }, - { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "State of the Service from LB rule", - "name": "servicestate", - "type": "string" - }, - { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" - }, - { - "description": "the write (bytes) of disk on the vm", - "name": "diskkbswrite", - "type": "long" - }, - { - "description": "the internal memory that's free in vm or zero if it can not be calculated", - "name": "memoryintfreekbs", - "type": "long" - }, - { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" - }, - { - "description": "the write (io) of disk on the vm", - "name": "diskiowrite", - "type": "long" - }, - { - "description": "the name of the disk offering of the virtual machine", - "name": "diskofferingname", + "description": "the group ID of the virtual machine", + "name": "groupid", "type": "string" }, { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", "type": "string" }, { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" - }, - { - "description": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", + "description": "the list of resource tags associated", + "name": "tags", "response": [ { - "description": "the ID of the affinity group", - "name": "id", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the domain ID of the affinity group", - "name": "domainid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the type of the affinity group", - "name": "type", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" + "description": "tag key name", + "name": "key", + "type": "string" }, { - "description": "the project name of the affinity group", + "description": "the project name where tag belongs to", "name": "project", "type": "string" }, { - "description": "the name of the affinity group", - "name": "name", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the project ID of the affinity group", + "description": "the project id the tag belongs to", "name": "projectid", "type": "string" }, { - "description": "the domain name of the affinity group", - "name": "domain", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the description of the affinity group", - "name": "description", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the account owning the affinity group", - "name": "account", + "description": "tag value", + "name": "value", "type": "string" } ], "type": "set" }, { - "description": "the number of cpu this virtual machine is running with", - "name": "cpunumber", + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" + }, + { + "description": "the memory allocated for the virtual machine", + "name": "memory", "type": "integer" }, { - "description": "the ID of the availablility zone for the virtual machine", - "name": "zoneid", + "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": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" + }, + { + "description": "Guest vm Boot Mode", + "name": "bootmode", "type": "string" }, { - "description": "the account associated with the virtual machine", - "name": "account", + "description": "the project name of the vm", + "name": "project", "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 virtual machine", + "name": "id", "type": "string" }, { - "description": "the incoming network traffic on the vm", - "name": "networkkbsread", + "description": "the name of the virtual machine", + "name": "name", + "type": "string" + }, + { + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", + "type": "string" + }, + {}, + { + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", "type": "long" }, { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" + }, + { + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", "type": "string" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "the memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" + }, + { + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { - "description": "device type of the root volume", - "name": "rootdevicetype", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "the project name of the vm", - "name": "project", + "description": "the ID of the disk offering of the virtual machine", + "name": "diskofferingid", "type": "string" }, { - "description": "OS type id of the vm", - "name": "ostypeid", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" + "description": "Guest vm Boot Type", + "name": "boottype", + "type": "string" }, { - "description": "the read (bytes) of disk on the vm", - "name": "diskkbsread", - "type": "long" + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", + "type": "string" }, { "description": "the name of the domain in which the virtual machine exists", @@ -34932,33 +35978,53 @@ "type": "string" }, { - "description": "the name of the host for the virtual machine", - "name": "hostname", + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" + }, + { + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", "type": "string" }, { - "description": "the read (io) of disk on the vm", - "name": "diskioread", + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", "type": "long" }, { - "description": "the target memory in vm", - "name": "memorytargetkbs", + "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 ID of the availablility zone for the virtual machine", + "name": "zoneid", + "type": "string" }, { - "description": "the speed of each cpu", + "description": "the speed of each vCPU", "name": "cpuspeed", "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "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 password (if exists) of the virtual machine", + "name": "password", + "type": "string" + }, + { + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", "type": "string" }, { @@ -34967,420 +36033,68 @@ "type": "boolean" }, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "list of security groups associated with the virtual machine", - "name": "securitygroup", - "response": [ - { - "description": "the project id of the group", - "name": "projectid", - "type": "string" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the 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 description of the security group", - "name": "description", - "type": "string" - }, - { - "description": "the account owning the security group", - "name": "account", - "type": "string" - }, - { - "description": "the name of the security group", - "name": "name", - "type": "string" - }, - { - "description": "the 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 ID of the security group", - "name": "id", - "type": "string" - }, - { - "description": "the list of egress rules associated with the security group", - "name": "egressrule", - "response": [ - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, - { - "description": "the 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 list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, - { - "description": "account owning the security group rule", - "name": "account", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the project name of the group", - "name": "project", - "type": "string" - }, - { - "description": "the list of ingress rules associated with the security group", - "name": "ingressrule", - "response": [ - { - "description": "the 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 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": "security group name", - "name": "securitygroupname", - "type": "string" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "account owning the security group rule", - "name": "account", - "type": "string" - }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - } - ], - "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": "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": "Vm details in key/value pairs.", + "name": "details", + "type": "map" + }, { "description": "the list of nics associated with vm", "name": "nic", "response": [ - { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", - "type": "string" - }, - { - "description": "the traffic type of the nic", - "name": "traffictype", - "type": "string" - }, { "description": "the isolated private VLAN if available", "name": "isolatedpvlan", "type": "integer" }, { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", - "type": "string" - }, - { - "description": "the ID of the nic", - "name": "id", - "type": "string" - }, - { - "description": "the name of the corresponding network", - "name": "networkname", - "type": "string" - }, - { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" - }, - { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - }, - { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", + "type": "string" }, { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "the netmask of the nic", + "name": "netmask", "type": "string" }, + { + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, { "description": "the type of the nic", "name": "type", "type": "string" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "the ip address of the nic", + "name": "ipaddress", "type": "string" }, { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "description": "the name of the corresponding network", + "name": "networkname", "type": "string" }, { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", - "type": "string" + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" }, { "description": "the gateway of the nic", @@ -35388,38 +36102,38 @@ "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 netmask of the nic", - "name": "netmask", + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", "type": "string" }, { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "the 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": "the ip address of the nic", - "name": "ipaddress", + "description": "the traffic type of the nic", + "name": "traffictype", "type": "string" }, { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the isolation uri of the nic", + "name": "isolationuri", "type": "string" }, { @@ -35433,359 +36147,530 @@ "type": "string" }, { - "description": "the ID of the corresponding network", - "name": "networkid", - "type": "string" - }, - { - "description": "the IPv6 address of network", - "name": "ip6address", - "type": "string" - } - ], - "type": "set" - }, - { - "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 ID of the host for the virtual machine", - "name": "hostid", - "type": "string" - }, - { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", - "type": "string" - }, - { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", - "type": "string" - }, - { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", - "type": "string" - }, - { - "description": "the list of resource tags associated", - "name": "tags", - "response": [ - { - "description": "the account associated with the tag", - "name": "account", + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the ID of the corresponding network", + "name": "networkid", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", - "type": "string" + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the ID of the nic", + "name": "id", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", - "type": "string" + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" }, { - "description": "tag key name", - "name": "key", + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the IPv6 address of network", + "name": "ip6address", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", "type": "string" } ], "type": "set" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", - "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": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", "type": "string" }, { - "description": "the 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": "Lists all static routes", - "isasync": false, - "name": "listStaticRoutes", - "params": [ - { - "description": "list static routes by gateway id", - "length": 255, - "name": "gatewayid", - "related": "createPrivateGateway", - "required": false, - "type": "uuid" - }, - { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", - "length": 255, - "name": "isrecursive", - "required": false, - "type": "boolean" - }, - { - "description": "list static route by id", - "length": 255, - "name": "id", - "related": "listStaticRoutes", - "required": false, - "type": "uuid" - }, - { - "description": "list objects by project", - "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,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", - "required": false, - "type": "uuid" + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" }, { - "description": "List resources by tags (key/value pairs)", - "length": 255, - "name": "tags", - "required": false, - "type": "map" + "description": "Os type ID of the virtual machine", + "name": "guestosid", + "type": "string" }, { - "description": "list resources by account. Must be used with the domainId parameter.", - "length": 255, - "name": "account", - "required": false, + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", "type": "integer" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" + "description": "the account associated with the virtual machine", + "name": "account", + "type": "string" }, { - "description": "list static routes by vpc id", - "length": 255, - "name": "vpcid", - "related": "createVPC,listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", - "required": false, - "type": "uuid" + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", + "type": "string" }, + {}, { - "description": "list static routes by state", - "length": 255, - "name": "state", - "required": false, + "description": "the project id of the vm", + "name": "projectid", "type": "string" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false", - "length": 255, - "name": "listall", - "required": false, + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" - } - ], - "related": "", - "response": [ - { - "description": "the project name of the static route", - "name": "project", - "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 state of the static route", - "name": "state", + "description": "the user's ID who deployed the virtual machine", + "name": "userid", "type": "string" }, { - "description": "VPC the static route belongs to", - "name": "vpcid", - "type": "string" + "description": "the read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" }, { - "description": "static route CIDR", - "name": "cidr", + "description": "OS type id of the vm", + "name": "ostypeid", "type": "string" }, { - "description": "the list of resource tags associated with static route", - "name": "tags", + "description": "list of security groups associated with the virtual machine", + "name": "securitygroup", "response": [ { - "description": "resource type", - "name": "resourcetype", + "description": "the domain name of the security group", + "name": "domain", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the project id of the group", + "name": "projectid", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the account owning the security group", + "name": "account", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the domain ID of the security group", + "name": "domainid", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the ID of the security group", + "name": "id", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", - "type": "string" + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + } + ], + "type": "set" }, { - "description": "tag key name", - "name": "key", + "description": "the list of ingress rules associated with the security group", + "name": "ingressrule", + "response": [ + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "account owning the security group rule", + "name": "account", + "type": "string" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + } + ], + "type": "set" + }, + { + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" + }, + { + "description": "the project name of the group", + "name": "project", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the list of egress rules associated with the security group", + "name": "egressrule", + "response": [ + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "account owning the security group rule", + "name": "account", + "type": "string" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + } + ], + "type": "set" + }, + { + "description": "the name of the security group", + "name": "name", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the description of the security group", + "name": "description", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" } ], - "type": "list" + "type": "set" }, { - "description": "VPC gateway the route is created for", - "name": "gatewayid", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "description": "the project id of the static route", - "name": "projectid", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "the ID of static route", - "name": "id", + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", "type": "string" }, { - "description": "the ID of the domain associated with the static route", - "name": "domainid", + "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 host for the virtual machine", + "name": "hostname", "type": "string" }, { - "description": "the account associated with the static route", - "name": "account", + "description": "device type of the root volume", + "name": "rootdevicetype", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" }, { - "description": "the domain associated with the static route", - "name": "domain", + "description": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" + }, + { + "description": "State of the Service from LB rule", + "name": "servicestate", + "type": "string" + }, + { + "description": "ssh key-pairs", + "name": "keypairs", "type": "string" } ] }, { - "description": "Lists all public ip addresses", + "description": "Lists all static routes", "isasync": false, - "name": "listPublicIpAddresses", + "name": "listStaticRoutes", "params": [ { - "description": "List IPs belonging to the VPC", + "description": "list static routes by vpc id", "length": 255, "name": "vpcid", "related": "createVPC,listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", @@ -35793,50 +36678,43 @@ "type": "uuid" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "list static routes by state", "length": 255, - "name": "account", + "name": "state", "required": false, "type": "string" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "list static route by id", "length": 255, - "name": "isrecursive", + "name": "id", + "related": "listStaticRoutes", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "fordisplay", + "name": "isrecursive", "required": false, - "since": "4.4", "type": "boolean" }, { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, { - "description": "the virtual network for the IP address", - "length": 255, - "name": "forvirtualnetwork", - "required": false, - "type": "boolean" - }, - { - "description": "list only IPs used for load balancing", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "forloadbalancing", + "name": "listall", "required": false, "type": "boolean" }, { - "description": "list objects by project", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, "name": "projectid", "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", @@ -35844,58 +36722,12 @@ "type": "uuid" }, { - "description": "lists the specified IP address", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "ipaddress", + "name": "account", "required": false, "type": "string" }, - { - "description": "lists all public IP addresses by source network ID", - "length": 255, - "name": "networkid", - "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listF5LoadBalancerNetworks,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listSrxFirewallNetworks,listBrocadeVcsDeviceNetworks", - "required": false, - "since": "4.13.0", - "type": "uuid" - }, - { - "description": "List resources by tags (key/value pairs)", - "length": 255, - "name": "tags", - "required": false, - "type": "map" - }, - { - "description": "list only static NAT IP addresses", - "length": 255, - "name": "isstaticnat", - "required": false, - "type": "boolean" - }, - { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, - { - "description": "lists IP address by ID", - "length": 255, - "name": "id", - "related": "associateIpAddress,listPublicIpAddresses,updateIpAddress,associateIpAddress,listPublicIpAddresses", - "required": false, - "type": "uuid" - }, - { - "description": "lists all public IP addresses by VLAN ID", - "length": 255, - "name": "vlanid", - "related": "createVlanIpRange,updateVlanIpRange,listVlanIpRanges,dedicatePublicIpRange", - "required": false, - "type": "uuid" - }, { "description": "List by keyword", "length": 255, @@ -35903,21 +36735,6 @@ "required": false, "type": "string" }, - { - "description": "lists all public IP addresses by physical network ID", - "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork", - "required": false, - "type": "uuid" - }, - { - "description": "list only source NAT IP addresses", - "length": 255, - "name": "issourcenat", - "required": false, - "type": "boolean" - }, { "description": "list only resources belonging to the domain specified", "length": 255, @@ -35927,229 +36744,58 @@ "type": "uuid" }, { - "description": "lists all public IP addresses associated to the network specified", + "description": "list static routes by gateway id", "length": 255, - "name": "associatednetworkid", - "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listF5LoadBalancerNetworks,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listSrxFirewallNetworks,listBrocadeVcsDeviceNetworks", + "name": "gatewayid", + "related": "createPrivateGateway,createPrivateGateway", "required": false, "type": "uuid" }, { - "description": "limits search results to allocated public IP addresses", - "length": 255, - "name": "allocatedonly", - "required": false, - "type": "boolean" - }, - { - "description": "lists all public IP addresses by state", - "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", + "description": "List resources by tags (key/value pairs)", "length": 255, - "name": "listall", + "name": "tags", "required": false, - "type": "boolean" + "type": "map" }, { - "description": "lists all public IP addresses by zone ID", + "description": "", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" } ], - "related": "associateIpAddress,updateIpAddress,associateIpAddress,listPublicIpAddresses", + "related": "", "response": [ { - "description": "the project name of the address", - "name": "project", - "type": "string" - }, - { - "description": "the domain ID the public IP address is associated with", - "name": "domainid", - "type": "string" - }, - { - "description": "the ID of the Network where ip belongs to", - "name": "networkid", - "type": "string" - }, - { - "description": "the name of the Network associated with the IP address", - "name": "associatednetworkname", - "type": "string" - }, - { - "description": "the project id of the ipaddress", + "description": "the project id of the static route", "name": "projectid", "type": "string" }, - { - "description": "virtual machine (dnat) ip address (not null only for static nat Ip)", - "name": "vmipaddress", - "type": "string" - }, - { - "description": "the account the public IP address is associated with", - "name": "account", - "type": "string" - }, - { - "description": "the name of the zone the public IP address belongs to", - "name": "zonename", - "type": "string" - }, - { - "description": "true if the IP address is a source nat address, false otherwise", - "name": "issourcenat", - "type": "boolean" - }, - { - "description": "the ID of the zone the public IP address belongs to", - "name": "zoneid", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - {}, - { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", - "type": "string" - }, - { - "description": "date the public IP address was acquired", - "name": "allocated", - "type": "date" - }, - { - "description": "the name of the Network where ip belongs to", - "name": "networkname", - "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 this ip is for static nat, false otherwise", - "name": "isstaticnat", - "type": "boolean" - }, {}, { - "description": "virtual machine id the ip address is assigned to (not null only for static nat Ip)", - "name": "virtualmachineid", - "type": "string" - }, - { - "description": "VPC id the ip belongs to", - "name": "vpcid", - "type": "string" - }, - { - "description": "public IP address id", - "name": "id", - "type": "string" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "is public IP portable across the zones", - "name": "isportable", - "type": "boolean" - }, - { - "description": "true if this ip is system ip (was allocated as a part of deployVm or createLbRule)", - "name": "issystem", - "type": "boolean" - }, - { - "description": "public IP address", - "name": "ipaddress", - "type": "string" - }, - { - "description": "State of the ip address. Can be: Allocatin, Allocated and Releasing", - "name": "state", - "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": "VPC name the ip belongs to", - "name": "vpcname", - "type": "string" - }, - { - "description": "virtual machine name the ip address is assigned to (not null only for static nat Ip)", - "name": "virtualmachinename", - "type": "string" - }, - { - "description": "the ID of the VLAN associated with the IP address. This parameter is visible to ROOT admins only", - "name": "vlanid", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the ID of the Network associated with the IP address", - "name": "associatednetworkid", - "type": "string" - }, - { - "description": "the domain the public IP address is associated with", - "name": "domain", - "type": "string" - }, - { - "description": "the virtual network for the IP address", - "name": "forvirtualnetwork", - "type": "boolean" - }, - { - "description": "the list of resource tags associated with ip address", + "description": "the list of resource tags associated with static route", "name": "tags", "response": [ { - "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": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { @@ -36158,23 +36804,23 @@ "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { @@ -36186,22 +36832,75 @@ "type": "list" }, { - "description": "the VLAN associated with the IP address", - "name": "vlanname", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "VPC the static route belongs to", + "name": "vpcid", + "type": "string" + }, + { + "description": "the ID of the domain associated with the static route", + "name": "domainid", + "type": "string" + }, + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the domain associated with the static route", + "name": "domain", + "type": "string" + }, + { + "description": "the state of the static route", + "name": "state", + "type": "string" + }, + { + "description": "the account associated with the static route", + "name": "account", + "type": "string" + }, + { + "description": "the ID of static route", + "name": "id", + "type": "string" + }, + { + "description": "VPC gateway the route is created for", + "name": "gatewayid", "type": "string" }, { - "description": "is public ip for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "the project name of the static route", + "name": "project", + "type": "string" + }, + { + "description": "static route CIDR", + "name": "cidr", + "type": "string" } ] }, { - "description": "lists F5 load balancer devices", + "description": "Lists all public ip addresses", "isasync": false, - "name": "listF5LoadBalancers", + "name": "listPublicIpAddresses", "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, @@ -36210,17 +36909,25 @@ "type": "integer" }, { - "description": "List by keyword", + "description": "lists all public IP addresses by physical network ID", "length": 255, - "name": "keyword", + "name": "physicalnetworkid", + "related": "createPhysicalNetwork", + "required": false, + "type": "uuid" + }, + { + "description": "lists the specified IP address", + "length": 255, + "name": "ipaddress", "required": false, "type": "string" }, { - "description": "f5 load balancer device ID", + "description": "List IPs belonging to the VPC", "length": 255, - "name": "lbdeviceid", - "related": "addF5LoadBalancer,listF5LoadBalancers", + "name": "vpcid", + "related": "createVPC,listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", "required": false, "type": "uuid" }, @@ -36232,307 +36939,327 @@ "type": "integer" }, { - "description": "the Physical Network ID", + "description": "List resources by tags (key/value pairs)", "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork", + "name": "tags", "required": false, - "type": "uuid" - } - ], - "related": "addF5LoadBalancer", - "response": [ - { - "description": "the management IP address of the external load balancer", - "name": "ipaddress", - "type": "string" - }, - { - "description": "device name", - "name": "lbdevicename", - "type": "string" + "type": "map" }, - {}, { - "description": "the physical network to which this F5 device belongs to", - "name": "physicalnetworkid", + "description": "lists all public IP addresses by state", + "length": 255, + "name": "state", + "required": false, "type": "string" }, { - "description": "true if device is dedicated for an account", - "name": "lbdevicededicated", + "description": "the virtual network for the IP address", + "length": 255, + "name": "forvirtualnetwork", + "required": false, "type": "boolean" }, { - "description": "device capacity", - "name": "lbdevicecapacity", - "type": "long" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "device id of the F5 load balancer", - "name": "lbdeviceid", - "type": "string" - }, - { - "description": "the public interface of the load balancer", - "name": "publicinterface", - "type": "string" - }, - { - "description": "the private interface of the load balancer", - "name": "privateinterface", - "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": "list only resources belonging to the domain specified", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains", + "required": false, + "type": "uuid" }, { - "description": "device state", - "name": "lbdevicestate", - "type": "string" - } - ] - }, - { - "description": "Updates an ISO file.", - "isasync": false, - "name": "updateIso", - "params": [ - { - "description": "the name of the image file", + "description": "list only IPs used for load balancing", "length": 255, - "name": "name", + "name": "forloadbalancing", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "Details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].hypervisortoolsversion=xenserver61", + "description": "list only source NAT IP addresses", "length": 255, - "name": "details", + "name": "issourcenat", "required": false, - "type": "map" + "type": "boolean" }, { - "description": "true if the template type is routing i.e., if template is used to deploy router", + "description": "List by keyword", "length": 255, - "name": "isrouting", + "name": "keyword", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "true if the image supports the password reset feature; default is false", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "passwordenabled", + "name": "account", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "the ID of the OS type that best represents the OS of this image.", + "description": "lists all public IP addresses by zone ID", "length": 255, - "name": "ostypeid", - "related": "listOsTypes,addGuestOs", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, "type": "uuid" }, { - "description": "the ID of the image file", + "description": "lists all public IP addresses associated to the network specified", "length": 255, - "name": "id", - "related": "prepareTemplate,listIsos,registerIso,updateIso,copyTemplate,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", - "required": true, + "name": "associatednetworkid", + "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listSrxFirewallNetworks,listBrocadeVcsDeviceNetworks", + "required": false, "type": "uuid" }, { - "description": "the display text of the image", - "length": 4096, - "name": "displaytext", + "description": "lists all public IP addresses by source network ID", + "length": 255, + "name": "networkid", + "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listSrxFirewallNetworks,listBrocadeVcsDeviceNetworks", "required": false, - "type": "string" + "since": "4.13.0", + "type": "uuid" }, { - "description": "true if the template supports the sshkey upload feature; 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": "sshkeyenabled", + "name": "isrecursive", "required": false, "type": "boolean" }, { - "description": "optional boolean field, which indicates if details should be cleaned up or not (if set to true, details removed for this resource, details field ignored; if false or not set, no action)", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "cleanupdetails", + "name": "projectid", + "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "sort key of the template, integer", + "description": "lists all public IP addresses by VLAN ID", "length": 255, - "name": "sortkey", + "name": "vlanid", + "related": "createVlanIpRange,updateVlanIpRange,listVlanIpRanges,dedicatePublicIpRange", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "true if image is bootable, false otherwise; available only for updateIso API", + "description": "limits search results to allocated public IP addresses", "length": 255, - "name": "bootable", + "name": "allocatedonly", "required": false, "type": "boolean" }, { - "description": "the format for the image", + "description": "list only static NAT IP addresses", "length": 255, - "name": "format", + "name": "isstaticnat", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "true if template/ISO contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", + "description": "lists IP address by ID", "length": 255, - "name": "isdynamicallyscalable", + "name": "id", + "related": "associateIpAddress,listPublicIpAddresses,updateIpAddress,associateIpAddress,listPublicIpAddresses", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "true if the template requres HVM, false otherwise; available only for updateTemplate API", + "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", "length": 255, - "name": "requireshvm", + "name": "fordisplay", "required": false, + "since": "4.4", "type": "boolean" } ], - "related": "prepareTemplate,listIsos,registerIso,copyTemplate,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", + "related": "associateIpAddress,updateIpAddress,associateIpAddress,listPublicIpAddresses", "response": [ { - "description": "the tag of this template", - "name": "templatetag", - "type": "string" + "description": "is public ip for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, { - "description": "the status of the template", - "name": "status", + "description": "public IP address id", + "name": "id", "type": "string" }, { - "description": "the date this template was created", - "name": "created", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "date the public IP address was acquired", + "name": "allocated", "type": "date" }, { - "description": "the account id to which the template belongs", - "name": "accountid", + "description": "true if this ip is system ip (was allocated as a part of deployVm or createLbRule)", + "name": "issystem", + "type": "boolean" + }, + { + "description": "public IP address", + "name": "ipaddress", "type": "string" }, { - "description": "the template name", - "name": "name", + "description": "the name of the Network where ip belongs to", + "name": "networkname", "type": "string" }, { - "description": "the processor bit size", - "name": "bits", - "type": "int" + "description": "virtual machine id the ip address is assigned to (not null only for static nat Ip)", + "name": "virtualmachineid", + "type": "string" }, { - "description": "the name of the secondary storage host for the template", - "name": "hostname", + "description": "the ID of the VLAN associated with the IP address. This parameter is visible to ROOT admins only", + "name": "vlanid", "type": "string" }, { - "description": "true if the reset password feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" + "description": "virtual machine (dnat) ip address (not null only for static nat Ip)", + "name": "vmipaddress", + "type": "string" }, { - "description": "the ID of the zone for this template", - "name": "zoneid", + "description": "virtual machine display name the ip address is assigned to (not null only for static nat Ip)", + "name": "virtualmachinedisplayname", "type": "string" }, { - "description": "the name of the OS type for this template.", - "name": "ostypename", + "description": "virtual machine name the ip address is assigned to (not null only for static nat Ip)", + "name": "virtualmachinename", "type": "string" }, { - "description": "the size of the template", - "name": "size", - "type": "long" + "description": "the VLAN associated with the IP address", + "name": "vlanname", + "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "the account the public IP address is associated with", + "name": "account", + "type": "string" + }, + { + "description": "the domain ID the public IP address is associated with", + "name": "domainid", + "type": "string" + }, + { + "description": "true if the IP address is a source nat address, false otherwise", + "name": "issourcenat", "type": "boolean" }, { - "description": "the project id of the template", + "description": "the project id of the ipaddress", "name": "projectid", "type": "string" }, + { + "description": "the domain the public IP address is associated with", + "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 Network where ip belongs to", + "name": "networkid", + "type": "string" + }, + { + "description": "VPC name the ip belongs to", + "name": "vpcname", + "type": "string" + }, {}, { - "description": "the name of the zone for this template", + "description": "the name of the zone the public IP address belongs to", "name": "zonename", "type": "string" }, { - "description": "if Datadisk template, then id of the root disk template this template belongs to", - "name": "parenttemplateid", + "description": "State of the ip address. Can be: Allocatin, Allocated and Releasing", + "name": "state", "type": "string" }, { - "description": "true if template requires HVM enabled, false otherwise", - "name": "requireshvm", + "description": "the ID of the Network associated with the IP address", + "name": "associatednetworkid", + "type": "string" + }, + { + "description": "the name of the Network associated with the IP address", + "name": "associatednetworkname", + "type": "string" + }, + { + "description": "the physical network this belongs to", + "name": "physicalnetworkid", + "type": "string" + }, + { + "description": "purpose of the IP address. In Acton this value is not null for Ips with isSystem=true, and can have either StaticNat or LB value", + "name": "purpose", + "type": "string" + }, + { + "description": "the project name of the address", + "name": "project", + "type": "string" + }, + { + "description": "true if this ip is for static nat, false otherwise", + "name": "isstaticnat", "type": "boolean" }, - {}, { - "description": "VMware only: true if template is deployed without orchestrating disks and networks but \"as-is\" defined in the template.", - "name": "deployasis", + "description": "the ID of the zone the public IP address belongs to", + "name": "zoneid", + "type": "string" + }, + { + "description": "is public IP portable across the zones", + "name": "isportable", "type": "boolean" }, { - "description": "true if the template is managed across all Zones, false otherwise", - "name": "crossZones", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, + {}, { - "description": "the ID of the OS type for this template.", - "name": "ostypeid", - "type": "string" + "description": "the virtual network for the IP address", + "name": "forvirtualnetwork", + "type": "boolean" }, { - "description": "the list of resource tags associated", + "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 value", - "name": "value", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "tag value", + "name": "value", "type": "string" }, { @@ -36541,18 +37268,18 @@ "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": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { @@ -36561,562 +37288,436 @@ "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", "type": "string" } ], - "type": "set" - }, - { - "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": "VMware only: additional key/value details tied with deploy-as-is template", - "name": "deployasisdetails", - "type": "map" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the account name to which the template belongs", - "name": "account", - "type": "string" - }, - { - "description": "the ID of the domain to which the template belongs", - "name": "domainid", - "type": "string" - }, - { - "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", - "name": "isdynamicallyscalable", - "type": "boolean" - }, - { - "description": "the date this template was removed", - "name": "removed", - "type": "date" - }, - { - "description": "true if the ISO is bootable, false otherwise", - "name": "bootable", - "type": "boolean" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the ID of the secondary storage host for the template", - "name": "hostid", - "type": "string" - }, - { - "description": "the name of the domain to which the template belongs", - "name": "domain", - "type": "string" - }, - { - "description": "the URL which the template/iso is registered from", - "name": "url", - "type": "string" - }, - { - "description": "additional key/value details tied with template", - "name": "details", - "type": "map" - }, - { - "description": "the project name of the template", - "name": "project", - "type": "string" - }, - { - "description": "true if the template is extractable, false otherwise", - "name": "isextractable", - "type": "boolean" - }, - { - "description": "the format of the template.", - "name": "format", - "type": "imageformat" - }, - { - "description": "true if the template is ready to be deployed from, false otherwise.", - "name": "isready", - "type": "boolean" + "type": "list" }, { - "description": "the template ID of the parent template if present", - "name": "sourcetemplateid", + "description": "VPC id the ip belongs to", + "name": "vpcid", "type": "string" - }, + } + ] + }, + { + "description": "Updates an ISO file.", + "isasync": false, + "name": "updateIso", + "params": [ { - "description": "true if this template is a public template, false otherwise", - "name": "ispublic", - "type": "boolean" + "description": "the format for the image", + "length": 255, + "name": "format", + "required": false, + "type": "string" }, { - "description": "the template ID", - "name": "id", - "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 template display text", + "description": "the display text of the image", + "length": 4096, "name": "displaytext", + "required": false, "type": "string" }, { - "description": "true if template is sshkey enabled, false otherwise", + "description": "true if the template supports the sshkey upload feature; default is false", + "length": 255, "name": "sshkeyenabled", + "required": false, "type": "boolean" }, { - "description": "the physical size of the template", - "name": "physicalsize", - "type": "long" - }, - { - "description": "if root disk template, then ids of the datas disk templates this template owns", - "name": "childtemplates", - "type": "set" + "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 this template is a featured template, false otherwise", - "name": "isfeatured", + "description": "true if the template requires HVM, false otherwise; available only for updateTemplate API", + "length": 255, + "name": "requireshvm", + "required": false, "type": "boolean" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the name of the image file", + "length": 255, + "name": "name", + "required": false, "type": "string" }, { - "description": "Lists the download progress of a template across all secondary storages", - "name": "downloaddetails", - "type": "list" + "description": "sort key of the template, integer", + "length": 255, + "name": "sortkey", + "required": false, + "type": "integer" }, { - "description": "checksum of the template", - "name": "checksum", - "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", + "required": true, + "type": "uuid" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - } - ] - }, - { - "description": "Lists F5 external load balancer appliances added in a zone.", - "isasync": false, - "name": "listExternalLoadBalancers", - "params": [ + "description": "true if the image supports the password reset feature; default is false", + "length": 255, + "name": "passwordenabled", + "required": false, + "type": "boolean" + }, { - "description": "zone Id", + "description": "true if template/ISO contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "isdynamicallyscalable", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "", + "description": "true if image is bootable, false otherwise; available only for updateIso API", "length": 255, - "name": "pagesize", + "name": "bootable", "required": false, - "type": "integer" + "type": "boolean" }, { - "description": "", + "description": "true if the template type is routing i.e., if template is used to deploy router", "length": 255, - "name": "page", + "name": "isrouting", "required": false, - "type": "integer" + "type": "boolean" }, { - "description": "List by keyword", + "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": "keyword", + "name": "cleanupdetails", "required": false, - "type": "string" + "type": "boolean" } ], - "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost,addBaremetalHost", + "related": "prepareTemplate,listIsos,registerIso,copyTemplate,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", "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 date and time the host was created", - "name": "created", - "type": "date" + "description": "the template ID of the parent template if present", + "name": "sourcetemplateid", + "type": "string" }, { - "description": "the CPU speed of the host", - "name": "cpuspeed", - "type": "long" + "description": "the status of the template", + "name": "status", + "type": "string" }, { - "description": "the cluster type of the cluster that host belongs to", - "name": "clustertype", + "description": "if Datadisk template, then id of the root disk template this template belongs to", + "name": "parenttemplateid", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "true if template is sshkey enabled, false otherwise", + "name": "sshkeyenabled", "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 template ID", + "name": "id", + "type": "string" }, { - "description": "the outgoing network traffic on the host", - "name": "networkkbswrite", + "description": "the physical size of the template", + "name": "physicalsize", "type": "long" }, + {}, { - "description": "capabilities of the host", - "name": "capabilities", - "type": "string" - }, - { - "description": "the host hypervisor", - "name": "hypervisor", - "type": "hypervisortype" + "description": "VMware only: additional key/value details tied with deploy-as-is template", + "name": "deployasisdetails", + "type": "map" }, { - "description": "the Zone name of the host", - "name": "zonename", + "description": "the ID of the secondary storage host for the template", + "name": "hostid", "type": "string" }, { - "description": "the amount of the host's memory after applying the mem.overprovisioning.factor", - "name": "memorywithoverprovisioning", + "description": "the template name", + "name": "name", "type": "string" }, { - "description": "the OS category ID of the host", - "name": "oscategoryid", - "type": "string" + "description": "the processor bit size", + "name": "bits", + "type": "int" }, { - "description": "the cluster ID of the host", - "name": "clusterid", + "description": "the type of the template", + "name": "templatetype", "type": "string" }, { - "description": "the host HA information information", - "name": "hostha", - "type": "hostharesponse" + "description": "true if the reset password feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" }, { - "description": "the Pod ID of the host", - "name": "podid", + "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 size of the template", + "name": "size", + "type": "long" }, { - "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", - "name": "cpuallocatedwithoverprovisioning", - "type": "string" + "description": "true if the ISO is bootable, false otherwise", + "name": "bootable", + "type": "boolean" }, { - "description": "comma-separated list of tags for the host", - "name": "hosttags", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the date and time the host was last pinged", - "name": "lastpinged", - "type": "date" + "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", + "name": "isdynamicallyscalable", + "type": "boolean" }, { - "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", - "name": "memorytotal", - "type": "long" + "description": "true if the template is managed across all Zones, false otherwise", + "name": "crossZones", + "type": "boolean" }, { - "description": "events available for the host", - "name": "events", + "description": "the name of the secondary storage host for the template", + "name": "hostname", "type": "string" }, { - "description": "the host version", - "name": "version", - "type": "string" + "description": "the date this template was removed", + "name": "removed", + "type": "date" }, { - "description": "the amount of the host's CPU currently allocated", - "name": "cpuallocated", + "description": "the template display text", + "name": "displaytext", "type": "string" }, { - "description": "the amount of the host's memory currently allocated in bytes", - "name": "memoryallocatedbytes", - "type": "long" + "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", + "name": "directdownload", + "type": "boolean" }, { - "description": "the amount of the host's CPU currently allocated in MHz", - "name": "cpuallocatedvalue", - "type": "long" + "description": "the format of the template.", + "name": "format", + "type": "imageformat" }, { - "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor", - "name": "cpuwithoverprovisioning", + "description": "the name of the domain to which the template belongs", + "name": "domain", "type": "string" }, { - "description": "the amount of the host's memory currently allocated in percentage", - "name": "memoryallocatedpercentage", - "type": "string" + "description": "additional key/value details tied with template", + "name": "details", + "type": "map" }, + {}, { - "description": "the OS category name of the host", - "name": "oscategoryname", + "description": "the project name of the template", + "name": "project", "type": "string" }, { - "description": "the Pod name of the host", - "name": "podname", + "description": "the project id of the template", + "name": "projectid", "type": "string" }, { - "description": "the last time this host was annotated", - "name": "lastannotated", - "type": "date" - }, - { - "description": "the admin that annotated this host", - "name": "username", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the amount of the host's memory currently allocated", - "name": "memoryallocated", - "type": "long" - }, - { - "description": "the name of the host", - "name": "name", + "description": "the account id to which the template belongs", + "name": "accountid", "type": "string" }, { - "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise", - "name": "hahost", - "type": "boolean" - }, - { - "description": "the date and time the host was removed", - "name": "removed", - "type": "date" - }, - { - "description": "the Zone ID of the host", + "description": "the ID of the zone for this template", "name": "zoneid", "type": "string" }, { - "description": "true if local storage is active, false otherwise", - "name": "islocalstorageactive", - "type": "boolean" + "description": "Lists the download progress of a template across all secondary storages", + "name": "downloaddetails", + "type": "list" }, { - "description": "the amount of the host's CPU currently allocated in percentage", - "name": "cpuallocatedpercentage", - "type": "string" + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the 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" + } + ], + "type": "set" }, { - "description": "true if the host has capability to support UEFI boot", - "name": "ueficapability", + "description": "true if this template is a featured template, false otherwise", + "name": "isfeatured", "type": "boolean" }, { - "description": "the hypervisor version", - "name": "hypervisorversion", - "type": "string" - }, - { - "description": "the IP address of the host", - "name": "ipaddress", + "description": "the URL which the template/iso is registered from", + "name": "url", "type": "string" }, { - "description": "the number of CPU sockets on the host", - "name": "cpusockets", - "type": "integer" - }, - { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", - "type": "long" + "description": "true if the template is extractable, false otherwise", + "name": "isextractable", + "type": "boolean" }, { - "description": "the cluster name of the host", - "name": "clustername", + "description": "the ID of the domain to which the template belongs", + "name": "domainid", "type": "string" }, { - "description": "the total disk size of the host", - "name": "disksizetotal", - "type": "long" - }, - { - "description": "the host type", - "name": "type", - "type": "type" - }, - { - "description": "the state of the host", - "name": "state", - "type": "status" - }, - { - "description": "the CPU number of the host", - "name": "cpunumber", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": "the amount of the host's CPU currently used", - "name": "cpuused", - "type": "string" + "description": "true if template requires HVM enabled, false otherwise", + "name": "requireshvm", + "type": "boolean" }, { - "description": "the cpu average load on the host", - "name": "cpuloadaverage", - "type": "double" + "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 incoming network traffic on the host", - "name": "networkkbsread", - "type": "long" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, - {}, { - "description": "the ID of the host", - "name": "id", + "description": "the ID of the OS type for this template.", + "name": "ostypeid", "type": "string" }, { - "description": "the resource state of the host", - "name": "resourcestate", - "type": "string" + "description": "the date this template was created", + "name": "created", + "type": "date" }, { - "description": "Host details in key/value pairs.", - "name": "details", - "type": "map" + "description": "checksum of the template", + "name": "checksum", + "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 template is ready to be deployed from, false otherwise.", + "name": "isready", "type": "boolean" }, { - "description": "the host out-of-band management information", - "name": "outofbandmanagement", - "type": "outofbandmanagementresponse" - }, - { - "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": "Video RAM for this vGPU type", - "name": "videoram", - "type": "long" - }, - { - "description": "Maximum X resolution per display", - "name": "maxresolutionx", - "type": "long" - }, - { - "description": "Maximum Y resolution per display", - "name": "maxresolutiony", - "type": "long" - }, - { - "description": "Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type", - "name": "remainingcapacity", - "type": "long" - }, - { - "description": "Maximum vgpu can be created with this vgpu type on the given gpu group", - "name": "maxcapacity", - "type": "long" - }, - { - "description": "Model Name of vGPU", - "name": "vgputype", - "type": "string" - }, - { - "description": "Maximum no. of vgpu per gpu card (pgpu)", - "name": "maxvgpuperpgpu", - "type": "long" - } - ], - "type": "list" - } - ], - "type": "list" + "description": "if root disk template, then ids of the datas disk templates this template owns", + "name": "childtemplates", + "type": "set" }, { - "description": "the management server ID of the host", - "name": "managementserverid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {}, { - "description": "the amount of the host's memory currently used", - "name": "memoryused", - "type": "long" + "description": "the tag of this template", + "name": "templatetag", + "type": "string" }, { - "description": "the last annotation set on this host by an admin", - "name": "annotation", - "type": "string" + "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": "the name of the OS type for this template.", + "name": "ostypename", + "type": "string" } ] }, @@ -37126,18 +37727,18 @@ "name": "listOpenDaylightControllers", "params": [ { - "description": "the ID of a OpenDaylight Controller", + "description": "the Physical Network ID", "length": 255, - "name": "id", - "related": "addOpenDaylightController,deleteOpenDaylightController,listOpenDaylightControllers", + "name": "physicalnetworkid", + "related": "createPhysicalNetwork", "required": false, "type": "uuid" }, { - "description": "the Physical Network ID", + "description": "the ID of a OpenDaylight Controller", "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork", + "name": "id", + "related": "addOpenDaylightController,deleteOpenDaylightController,listOpenDaylightControllers", "required": false, "type": "uuid" } @@ -37145,42 +37746,42 @@ "related": "addOpenDaylightController,deleteOpenDaylightController", "response": [ { - "description": "device id of the controller", - "name": "id", + "description": "the physical network to which this controller belongs to", + "name": "physicalnetworkid", "type": "string" }, {}, { - "description": "the url of the controller api", - "name": "url", + "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", + "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 physical network to which this controller belongs to", - "name": "physicalnetworkid", + "description": "the name assigned to the controller", + "name": "name", "type": "string" }, { - "description": "the name assigned to the controller", - "name": "name", + "description": "the url of the controller api", + "name": "url", "type": "string" }, { - "description": "the username to authenticate to the controller", - "name": "username", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {} + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } ] }, { @@ -37189,53 +37790,47 @@ "name": "addBigSwitchBcfDevice", "params": [ { - "description": "Password of the BigSwitch BCF Controller.", + "description": "the Physical Network ID", "length": 255, - "name": "password", + "name": "physicalnetworkid", + "related": "createPhysicalNetwork", "required": true, - "type": "string" + "type": "uuid" }, { - "description": "Hostname of ip address of the BigSwitch BCF Controller.", + "description": "NAT support of the BigSwitch BCF Controller.", "length": 255, - "name": "hostname", + "name": "nat", "required": true, - "type": "string" + "type": "boolean" }, { - "description": "Username of the BigSwitch BCF Controller.", + "description": "Password of the BigSwitch BCF Controller.", "length": 255, - "name": "username", + "name": "password", "required": true, "type": "string" }, { - "description": "the Physical Network ID", + "description": "Hostname of ip address of the BigSwitch BCF Controller.", "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork", + "name": "hostname", "required": true, - "type": "uuid" + "type": "string" }, { - "description": "NAT support of the BigSwitch BCF Controller.", + "description": "Username of the BigSwitch BCF Controller.", "length": 255, - "name": "nat", + "name": "username", "required": true, - "type": "boolean" + "type": "string" } ], "related": "listBigSwitchBcfDevices", "response": [ { - "description": "name of the provider", - "name": "provider", - "type": "string" - }, - {}, - { - "description": "the controller Ip address", - "name": "hostname", + "description": "the controller username", + "name": "username", "type": "string" }, { @@ -37248,30 +37843,36 @@ "name": "bcfdeviceid", "type": "string" }, - {}, { - "description": "the controller username", - "name": "username", + "description": "device name", + "name": "bigswitchdevicename", "type": "string" }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {}, { "description": "NAT support", "name": "nat", "type": "boolean" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the controller Ip address", + "name": "hostname", + "type": "string" }, { - "description": "the controller password", - "name": "password", + "description": "name of the provider", + "name": "provider", "type": "string" }, + {}, { - "description": "device name", - "name": "bigswitchdevicename", + "description": "the controller password", + "name": "password", "type": "string" }, { @@ -37297,12 +37898,16 @@ } ], "response": [ - {}, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, {}, { "description": "the current status of the latest async job acting on this object", @@ -37314,11 +37919,7 @@ "name": "displaytext", "type": "string" }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - } + {} ] }, { @@ -37346,159 +37947,456 @@ "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance", "response": [ { - "description": "the internal memory that's free in vm or zero if it can not be calculated", - "name": "memoryintfreekbs", - "type": "long" + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" }, { - "description": "the 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": "public IP address id associated with vm via Static nat rule", - "name": "publicip", - "type": "string" + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", + "type": "boolean" }, { - "description": "the incoming network traffic on the vm", - "name": "networkkbsread", + "description": "the memory used by the VM in KiB", + "name": "memorykbs", "type": "long" }, { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", + "description": "Guest vm Boot Type", + "name": "boottype", "type": "string" }, { - "description": "the group name of the virtual machine", - "name": "group", + "description": "ssh key-pairs", + "name": "keypairs", "type": "string" }, + {}, { - "description": "OS type id of the vm", - "name": "ostypeid", + "description": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" + }, + { + "description": "the list of nics associated with vm", + "name": "nic", + "response": [ + { + "description": "the isolation uri of the nic", + "name": "isolationuri", + "type": "string" + }, + { + "description": "the ip address of the nic", + "name": "ipaddress", + "type": "string" + }, + { + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "the name of the corresponding network", + "name": "networkname", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "macaddress", + "type": "string" + }, + { + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "the IPv6 address of network", + "name": "ip6address", + "type": "string" + }, + { + "description": "the ID of the corresponding network", + "name": "networkid", + "type": "string" + }, + { + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "the broadcast uri of the nic", + "name": "broadcasturi", + "type": "string" + }, + { + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", + "type": "string" + }, + { + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", + "type": "string" + }, + { + "description": "the netmask of the nic", + "name": "netmask", + "type": "string" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" + }, + { + "description": "the gateway of the nic", + "name": "gateway", + "type": "string" + }, + { + "description": "the type of the nic", + "name": "type", + "type": "string" + }, + { + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", + "type": "string" + }, + { + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + }, + { + "description": "the ID of the nic", + "name": "id", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", + "type": "string" + }, + { + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" + }, + { + "description": "the traffic type of the nic", + "name": "traffictype", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", + "type": "string" + }, + { + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", + "response": [ + { + "description": "the name of the affinity group", + "name": "name", + "type": "string" + }, + { + "description": "the domain name of the affinity group", + "name": "domain", + "type": "string" + }, + { + "description": "the project name of the affinity group", + "name": "project", + "type": "string" + }, + { + "description": "the description of the affinity group", + "name": "description", + "type": "string" + }, + { + "description": "the account owning the affinity group", + "name": "account", + "type": "string" + }, + { + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" + }, + { + "description": "the type of the affinity group", + "name": "type", + "type": "string" + }, + { + "description": "the project ID of the affinity group", + "name": "projectid", + "type": "string" + }, + { + "description": "the ID of the affinity group", + "name": "id", + "type": "string" + }, + { + "description": "the domain ID of the affinity group", + "name": "domainid", + "type": "string" + } + ], + "type": "set" + }, + { + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, + { + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" + }, { "description": "the ID of the ISO attached to the virtual machine", "name": "isoid", "type": "string" }, { - "description": "the memory allocated for the virtual machine", - "name": "memory", + "description": "the name of the virtual machine", + "name": "name", + "type": "string" + }, + { + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", + "type": "string" + }, + { + "description": "the user's name who deployed the virtual machine", + "name": "username", + "type": "string" + }, + { + "description": "the 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 project id of the vm", + "name": "projectid", "type": "string" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", + "description": "the user's ID who deployed the virtual machine", + "name": "userid", + "type": "string" + }, + { + "description": "the read (IO) of disk on the VM", + "name": "diskioread", "type": "long" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", + "type": "string" }, { - "description": "the read (io) of disk on the vm", - "name": "diskioread", + "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": "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": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", "type": "long" }, { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" + "description": "the name of the template for the virtual machine", + "name": "templatename", + "type": "string" }, { - "description": "the project id of the vm", - "name": "projectid", + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", "type": "string" }, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" + }, + { + "description": "the name of the disk offering of the virtual machine", + "name": "diskofferingname", "type": "string" }, { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", "type": "string" }, { - "description": "the project name of the vm", - "name": "project", + "description": "OS type id of the vm", + "name": "ostypeid", "type": "string" }, { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" + "description": "Guest vm Boot Mode", + "name": "bootmode", + "type": "string" }, { - "description": "the user's name who deployed the virtual machine", - "name": "username", + "description": "the account associated with the virtual machine", + "name": "account", "type": "string" }, { - "description": "the read (bytes) of disk on the vm", - "name": "diskkbsread", - "type": "long" + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", + "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "Os type ID of the virtual machine", + "name": "guestosid", + "type": "string" }, { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "the ID of 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 availability zone for the virtual machine", "name": "zonename", "type": "string" }, { - "description": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" + "description": "the ID of the availablility zone for the virtual machine", + "name": "zoneid", + "type": "string" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "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", + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", "type": "string" }, { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", "type": "string" }, + {}, { - "description": "the name of the host for the virtual machine", - "name": "hostname", + "description": "the ID of the host for the virtual machine", + "name": "hostid", "type": "string" }, { @@ -37506,387 +38404,256 @@ "name": "diskofferingid", "type": "string" }, - { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", - "type": "string" - }, - { - "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": "the password (if exists) of the virtual machine", - "name": "password", - "type": "string" + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" }, { - "description": "the name of the disk offering of the virtual machine", - "name": "diskofferingname", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", "type": "string" }, + {}, + { + "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": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "State of the Service from LB rule", + "name": "servicestate", "type": "string" }, { - "description": "the number of cpu this virtual machine is running with", - "name": "cpunumber", - "type": "integer" + "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.", - "name": "displayvm", - "type": "boolean" + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", + "type": "string" }, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", + "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": "Vm details in key/value pairs.", + "name": "details", + "type": "map" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "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": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", + "description": "the ID of the virtual machine", + "name": "id", "type": "string" }, { - "description": "the write (bytes) of disk on the vm", - "name": "diskkbswrite", - "type": "long" + "description": "the project name of the vm", + "name": "project", + "type": "string" }, { - "description": "the name of the virtual machine", - "name": "name", + "description": "the state of the virtual machine", + "name": "state", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "device type of the root volume", + "name": "rootdevicetype", "type": "string" }, { - "description": "the write (io) of disk on the vm", - "name": "diskiowrite", + "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": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" + }, + { + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" + }, + { + "description": "the password (if exists) of the virtual machine", + "name": "password", "type": "string" }, { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", + "description": "the name of the host for the virtual machine", + "name": "hostname", "type": "string" }, { - "description": "the speed of each cpu", - "name": "cpuspeed", - "type": "integer" + "description": "OS name of the vm", + "name": "osdisplayname", + "type": "string" }, { - "description": "ssh key-pair", - "name": "keypair", + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", "type": "string" }, { - "description": "the vgpu type used by the virtual machine", - "name": "vgpu", + "description": "the group name of the virtual machine", + "name": "group", "type": "string" }, + { + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" + }, { "description": "the name of the service offering of the virtual machine", "name": "serviceofferingname", "type": "string" }, { - "description": "the list of nics associated with vm", - "name": "nic", - "response": [ - { - "description": "the traffic type of the nic", - "name": "traffictype", - "type": "string" - }, - { - "description": "the ip address of the nic", - "name": "ipaddress", - "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 isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "description": "the IPv6 address of network", - "name": "ip6address", - "type": "string" - }, - { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", - "type": "string" - }, - { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", - "type": "string" - }, - { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" - }, - { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - }, - { - "description": "the type of the nic", - "name": "type", - "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": "Type of adapter if available", - "name": "adaptertype", - "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 extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" - }, - { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", - "type": "string" - }, - { - "description": "the gateway of the nic", - "name": "gateway", - "type": "string" - }, - { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", - "type": "string" - }, - { - "description": "the ID of the corresponding network", - "name": "networkid", - "type": "string" - }, - { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "true if nic is default, false otherwise", - "name": "macaddress", - "type": "string" - }, - { - "description": "the ID of the nic", - "name": "id", - "type": "string" - }, - { - "description": "the isolation uri of the nic", - "name": "isolationuri", - "type": "string" - } - ], - "type": "set" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the list of resource tags associated", - "name": "tags", + "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": "list of security groups associated with the virtual machine", + "name": "securitygroup", "response": [ { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "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", + "description": "the ID of the security group", + "name": "id", "type": "string" }, - { - "description": "tag key name", - "name": "key", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "list of security groups associated with the virtual machine", - "name": "securitygroup", - "response": [ { "description": "the domain ID of the security group", "name": "domainid", "type": "string" }, { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" + "description": "the domain name of the security group", + "name": "domain", + "type": "string" }, { - "description": "the ID of the security group", - "name": "id", + "description": "the name of the security group", + "name": "name", "type": "string" }, { - "description": "the list of ingress rules associated with the security group", - "name": "ingressrule", + "description": "the list of resource tags associated with the rule", + "name": "tags", "response": [ { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" + "description": "tag value", + "name": "value", + "type": "string" }, { - "description": "security group name", - "name": "securitygroupname", + "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": "resource type", + "name": "resourcetype", "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 starting IP of the security group rule", - "name": "startport", - "type": "integer" + "description": "id of the resource", + "name": "resourceid", + "type": "string" }, { - "description": "account owning the security group rule", - "name": "account", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the list of ingress rules associated with the security group", + "name": "ingressrule", + "response": [ + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ - { - "description": "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", @@ -37898,8 +38665,8 @@ "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { @@ -37907,14 +38674,19 @@ "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": "id of the resource", - "name": "resourceid", + "description": "tag key name", + "name": "key", "type": "string" }, { @@ -37923,38 +38695,83 @@ "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", "type": "string" } ], "type": "set" }, { - "description": "the id of the security group rule", - "name": "ruleid", + "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": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "account owning the security group rule", + "name": "account", "type": "string" + }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" } ], "type": "set" }, + { + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" + }, + { + "description": "the project id of the group", + "name": "projectid", + "type": "string" + }, + { + "description": "the account owning the security group", + "name": "account", + "type": "string" + }, + { + "description": "the project name of the group", + "name": "project", + "type": "string" + }, { "description": "the list of egress rules associated with the security group", "name": "egressrule", "response": [ { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "the id of the security group rule", - "name": "ruleid", + "description": "the protocol of the security group rule", + "name": "protocol", "type": "string" }, { @@ -37962,16 +38779,6 @@ "name": "startport", "type": "integer" }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, { "description": "security group name", "name": "securitygroupname", @@ -37983,27 +38790,27 @@ "type": "string" }, { - "description": "the protocol of the security group rule", - "name": "protocol", + "description": "the id of the security group rule", + "name": "ruleid", "type": "string" }, { - "description": "account owning the security group rule", - "name": "account", - "type": "string" + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "the project id the tag belongs to", - "name": "projectid", + "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" }, { @@ -38012,411 +38819,995 @@ "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the 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": "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 domain associated with the tag", - "name": "domain", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" } ], "type": "set" - } - ], - "type": "set" - }, - { - "description": "the project name of the group", - "name": "project", - "type": "string" - }, - { - "description": "the description of the security group", - "name": "description", - "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 id of the group", - "name": "projectid", - "type": "string" - }, - { - "description": "the domain name of the security group", - "name": "domain", - "type": "string" - }, - { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "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 code for the ICMP message response", + "name": "icmpcode", + "type": "integer" }, { - "description": "id of the resource", - "name": "resourceid", - "type": "string" + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" }, { - "description": "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": "tag value", - "name": "value", - "type": "string" } ], "type": "set" + }, + { + "description": "the description of the security group", + "name": "description", + "type": "string" } ], "type": "set" }, { - "description": "device type of the root volume", - "name": "rootdevicetype", + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" + }, + { + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", + "type": "string" + }, + { + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" + }, + { + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" + }, + { + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" + } + ] + }, + { + "description": "Deletes a user for an account", + "isasync": false, + "name": "deleteUser", + "params": [ + { + "description": "id of the user to be deleted", + "length": 255, + "name": "id", + "related": "createUser,disableUser,enableUser,getUser,listUsers,lockUser,updateUser", + "required": true, + "type": "uuid" + } + ], + "response": [ + {}, + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + }, + { + "description": "true if 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": "Initiates the specified power action to the host's out-of-band management interface", + "isasync": true, + "name": "issueOutOfBandManagementPowerAction", + "params": [ + { + "description": "out-of-band management power actions, valid actions are: ON, OFF, CYCLE, RESET, SOFT, STATUS", + "length": 255, + "name": "action", + "required": true, + "type": "string" + }, + { + "description": "optional operation timeout in seconds that overrides the global or cluster-level out-of-band management timeout setting", + "length": 255, + "name": "timeout", + "required": false, + "type": "long" + }, + { + "description": "the ID of the host", + "length": 255, + "name": "hostid", + "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost", + "required": true, + "type": "uuid" + } + ], + "related": "enableOutOfBandManagementForHost,disableOutOfBandManagementForHost,enableOutOfBandManagementForCluster,disableOutOfBandManagementForCluster", + "response": [ + { + "description": "true if out-of-band management is enabled for the host", + "name": "enabled", + "type": "boolean" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the ID of the host", + "name": "hostid", + "type": "string" + }, + { + "description": "the out-of-band management interface powerState of the host", + "name": "powerstate", + "type": "powerstate" + }, + { + "description": "the out-of-band management interface address", + "name": "address", + "type": "string" + }, + { + "description": "the out-of-band management action (if issued)", + "name": "action", + "type": "string" + }, + {}, + { + "description": "the out-of-band management interface port", + "name": "port", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the out-of-band management driver for the host", + "name": "driver", + "type": "string" + }, + {}, + { + "description": "the operation result", + "name": "status", + "type": "boolean" + }, + { + "description": "the out-of-band management interface username", + "name": "username", + "type": "string" + }, + { + "description": "the out-of-band management interface password", + "name": "password", + "type": "string" + }, + { + "description": "the operation result description", + "name": "description", + "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": "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": "Comma separated list of IP addresses, the certificate should be issued for", + "length": 255, + "name": "ipaddress", + "required": false, + "type": "string" + }, + { + "description": "The certificate signing request (in pem format), if CSR is not provided then configured/provided options are considered", + "length": 65535, + "name": "csr", + "required": false, + "type": "string" + }, + { + "description": "Certificate validity duration in number of days, when not provided the default configured value will be used", + "length": 255, + "name": "duration", + "required": false, + "type": "integer" + } + ], + "related": "listCaCertificate", + "response": [ + { + "description": "The client certificate", + "name": "certificate", + "type": "string" + }, + { + "description": "Private key for the certificate", + "name": "privatekey", + "type": "string" + }, + {}, + { + "description": "The CA certificate(s)", + "name": "cacertificates", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } + ], + "since": "4.11.0" + }, + { + "description": "Deletes network device.", + "isasync": false, + "name": "deleteNetworkDevice", + "params": [ + { + "description": "Id of network device to delete", + "length": 255, + "name": "id", + "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost", + "required": true, + "type": "uuid" + } + ], + "response": [ + {}, + {}, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + } + ] + }, + { + "description": "Updates image store read-only status", + "isasync": false, + "name": "updateImageStore", + "params": [ + { + "description": "Image Store UUID", + "length": 255, + "name": "id", + "related": "addSecondaryStorage,listSwifts,updateImageStore,addImageStore,addImageStoreS3,listImageStores,updateCloudToUseObjectStore", + "required": true, + "type": "uuid" + }, + { + "description": "If set to true, it designates the corresponding image store to read-only, hence not considering them during storage migration", + "length": 255, + "name": "readonly", + "required": true, + "type": "boolean" + } + ], + "related": "addSecondaryStorage,listSwifts,addImageStore,addImageStoreS3,listImageStores,updateCloudToUseObjectStore", + "response": [ + { + "description": "the protocol of the image store", + "name": "protocol", + "type": "string" + }, + { + "description": "the provider name of the image store", + "name": "providername", + "type": "string" + }, + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the Zone ID of the image store", + "name": "zoneid", + "type": "string" + }, + { + "description": "the total disk size of the host", + "name": "disksizetotal", + "type": "long" + }, + {}, + { + "description": "the ID of the image store", + "name": "id", + "type": "string" + }, + { + "description": "the url of the image store", + "name": "url", + "type": "string" + }, + { + "description": "defines if store is read-only", + "name": "readonly", + "type": "boolean" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the account associated with the virtual machine", - "name": "account", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the name of the image store", + "name": "name", "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", + "description": "the host's currently used disk size", + "name": "disksizeused", + "type": "long" + }, + { + "description": "the Zone name of the image store", + "name": "zonename", "type": "string" }, { - "description": "the state of the virtual machine", - "name": "state", + "description": "the scope of the image store", + "name": "scope", + "type": "scopetype" + } + ], + "since": "4.15.0" + }, + { + "description": "Creates a port forwarding rule", + "isasync": true, + "name": "createPortForwardingRule", + "params": [ + { + "description": "VM guest nic secondary IP address for the port forwarding rule", + "length": 255, + "name": "vmguestip", + "required": false, "type": "string" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", + "description": "the protocol for the port forwarding rule. Valid values are TCP or UDP.", + "length": 255, + "name": "protocol", + "required": true, "type": "string" }, { - "description": "Guest vm Boot Type", - "name": "boottype", + "description": "if true, firewall rule for source/end public port is automatically created; if false - firewall rule has to be created explicitly. If not specified 1) defaulted to false when PF rule is being created for VPC guest network 2) in all other cases defaulted to true", + "length": 255, + "name": "openfirewall", + "required": false, + "type": "boolean" + }, + { + "description": "the ID of the virtual machine for the port forwarding rule", + "length": 255, + "name": "virtualmachineid", + "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance", + "required": true, + "type": "uuid" + }, + { + "description": "the ending port of port forwarding rule's private port range", + "length": 255, + "name": "publicendport", + "required": false, + "type": "integer" + }, + { + "description": "the IP address id of the port forwarding rule", + "length": 255, + "name": "ipaddressid", + "related": "associateIpAddress,updateIpAddress,associateIpAddress,listPublicIpAddresses", + "required": true, + "type": "uuid" + }, + { + "description": "the starting port of port forwarding rule's public port range", + "length": 255, + "name": "publicport", + "required": true, + "type": "integer" + }, + { + "description": "the starting port of port forwarding rule's private port range", + "length": 255, + "name": "privateport", + "required": true, + "type": "integer" + }, + { + "description": "the ending port of port forwarding rule's private port range", + "length": 255, + "name": "privateendport", + "required": false, + "type": "integer" + }, + { + "description": "the network of the virtual machine the port forwarding rule will be created for. Required when public IP address is not associated with any guest network yet (VPC case).", + "length": 255, + "name": "networkid", + "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listSrxFirewallNetworks,listBrocadeVcsDeviceNetworks", + "required": false, + "type": "uuid" + }, + { + "description": "the cidr list to forward traffic from. Multiple entries must be separated by a single comma character (,). This parameter is deprecated. Do not use.", + "length": 255, + "name": "cidrlist", + "required": false, + "type": "list" + }, + { + "description": "an optional field, whether to the display the rule to the end user or not", + "length": 255, + "name": "fordisplay", + "required": false, + "since": "4.4", + "type": "boolean" + } + ], + "related": "createIpv6FirewallRule,updateIpv6FirewallRule,listPortForwardingRules,updatePortForwardingRule", + "response": [ + { + "description": "the ID of the port forwarding rule", + "name": "id", "type": "string" }, { - "description": "the pool type of the virtual machine", - "name": "pooltype", + "description": "the state of the rule", + "name": "state", "type": "string" }, - {}, { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", + "description": "the protocol of the port forwarding rule", + "name": "protocol", "type": "string" }, { - "description": "the target memory in vm", - "name": "memorytargetkbs", - "type": "long" + "description": "the ending port of port forwarding rule's private port range", + "name": "publicendport", + "type": "string" }, { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" + "description": "the VM ID for the port forwarding rule", + "name": "virtualmachineid", + "type": "string" }, { - "description": "OS name of the vm", - "name": "osdisplayname", + "description": "the public ip address for the port forwarding rule", + "name": "ipaddress", "type": "string" }, { - "description": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", + "description": "the id of the guest network the port forwarding rule belongs to", + "name": "networkid", + "type": "string" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", "response": [ { - "description": "the ID of the affinity group", - "name": "id", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the type of the affinity group", - "name": "type", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the description of the affinity group", - "name": "description", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the domain name of the affinity group", - "name": "domain", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" + "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 project ID of the affinity group", + "description": "the project id the tag belongs to", "name": "projectid", "type": "string" }, { - "description": "the account owning the affinity group", - "name": "account", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the project name of the affinity group", - "name": "project", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the domain ID of the affinity group", - "name": "domainid", + "description": "id of the resource", + "name": "resourceid", "type": "string" } ], - "type": "set" + "type": "list" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", + "type": "string" }, {}, { - "description": "the outgoing network traffic on the host", - "name": "networkkbswrite", - "type": "long" + "description": "the starting port of port forwarding rule's private port range", + "name": "privateport", + "type": "string" + }, + {}, + { + "description": "the VM name for the port forwarding rule", + "name": "virtualmachinename", + "type": "string" }, { - "description": "the memory used by the vm", - "name": "memorykbs", - "type": "long" + "description": "the ending port of port forwarding rule's private port range", + "name": "privateendport", + "type": "string" }, { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", + "description": "the public ip address id for the port forwarding rule", + "name": "ipaddressid", "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 ID of the virtual machine", - "name": "id", + "description": "the vm ip address for the port forwarding rule", + "name": "vmguestip", "type": "string" }, { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" + "description": "the starting port of port forwarding rule's public port range", + "name": "publicport", + "type": "string" }, { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", + "description": "is firewall for display to the regular user", + "name": "fordisplay", "type": "boolean" + }, + { + "description": "the VM display name for the port forwarding rule", + "name": "virtualmachinedisplayname", + "type": "string" } ] }, { - "description": "Deletes a user for an account", + "description": "load template into primary storage", "isasync": false, - "name": "deleteUser", + "name": "prepareTemplate", "params": [ { - "description": "id of the user to be deleted", + "description": "template ID of the template to be prepared in primary storage(s).", "length": 255, - "name": "id", - "related": "createUser,disableUser,enableUser,getUser,listUsers,lockUser,updateUser", + "name": "templateid", + "related": "prepareTemplate,listIsos,registerIso,copyTemplate,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", + "required": true, + "type": "uuid" + }, + { + "description": "storage pool ID of the primary storage pool to which the template should be prepared. If it is not provided the template is prepared on all the available primary storage pools.", + "length": 255, + "name": "storageid", + "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities", + "required": false, + "type": "uuid" + }, + { + "description": "zone ID of the template to be prepared in primary storage(s).", + "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", "response": [ { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "true if this template is a public template, false otherwise", + "name": "ispublic", + "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the name of the domain to which the template belongs", + "name": "domain", "type": "string" }, - {}, { - "description": "true if operation is executed successfully", - "name": "success", + "description": "the ID of the domain to which the template belongs", + "name": "domainid", + "type": "string" + }, + { + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" + }, + { + "description": "additional key/value details tied with template", + "name": "details", + "type": "map" + }, + { + "description": "true if this template is a featured template, false otherwise", + "name": "isfeatured", "type": "boolean" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the template ID", + "name": "id", "type": "string" }, - {} - ] - }, - { - "description": "Initiates the specified power action to the host's out-of-band management interface", - "isasync": true, - "name": "issueOutOfBandManagementPowerAction", - "params": [ { - "description": "the ID of the host", - "length": 255, - "name": "hostid", - "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost,addBaremetalHost", - "required": true, - "type": "uuid" + "description": "true if the ISO is bootable, false otherwise", + "name": "bootable", + "type": "boolean" }, { - "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, + "description": "the account id to which the template belongs", + "name": "accountid", + "type": "string" + }, + { + "description": "the name of the secondary storage host for the template", + "name": "hostname", + "type": "string" + }, + { + "description": "the format of the template.", + "name": "format", + "type": "imageformat" + }, + { + "description": "the physical size of the template", + "name": "physicalsize", "type": "long" }, { - "description": "out-of-band management power actions, valid actions are: ON, OFF, CYCLE, RESET, SOFT, STATUS", - "length": 255, - "name": "action", - "required": true, + "description": "the type of the template", + "name": "templatetype", "type": "string" - } - ], - "related": "enableOutOfBandManagementForHost,disableOutOfBandManagementForHost,enableOutOfBandManagementForCluster,disableOutOfBandManagementForCluster", - "response": [ + }, + { + "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", + "name": "isdynamicallyscalable", + "type": "boolean" + }, + { + "description": "the ID of the OS type for this template.", + "name": "ostypeid", + "type": "string" + }, + { + "description": "the tag of this template", + "name": "templatetag", + "type": "string" + }, + { + "description": "the date this template was created", + "name": "created", + "type": "date" + }, + { + "description": "if root disk template, then ids of the datas disk templates this template owns", + "name": "childtemplates", + "type": "set" + }, + { + "description": "VMware only: true if template is deployed without orchestrating disks and networks but \"as-is\" defined in the template.", + "name": "deployasis", + "type": "boolean" + }, + { + "description": "true if template is sshkey enabled, false otherwise", + "name": "sshkeyenabled", + "type": "boolean" + }, + {}, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the template display text", + "name": "displaytext", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the name of the zone for this template", + "name": "zonename", + "type": "string" + }, + { + "description": "the template ID of the parent template if present", + "name": "sourcetemplateid", + "type": "string" + }, + { + "description": "Lists the download progress of a template across all secondary storages", + "name": "downloaddetails", + "type": "list" + }, + { + "description": "if Datadisk template, then id of the root disk template this template belongs to", + "name": "parenttemplateid", + "type": "string" + }, + { + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the project name of the template", + "name": "project", + "type": "string" + }, + { + "description": "VMware only: additional key/value details tied with deploy-as-is template", + "name": "deployasisdetails", + "type": "map" + }, + { + "description": "true if the reset password feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" + }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "true if template requires HVM enabled, false otherwise", + "name": "requireshvm", + "type": "boolean" }, { - "description": "the out-of-band management interface powerState of the host", - "name": "powerstate", - "type": "powerstate" + "description": "the size of the template", + "name": "size", + "type": "long" }, { - "description": "the out-of-band management action (if issued)", - "name": "action", + "description": "the name of the OS type for this template.", + "name": "ostypename", "type": "string" }, { - "description": "true if out-of-band management is enabled for the host", - "name": "enabled", + "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", + "name": "directdownload", "type": "boolean" }, { - "description": "the ID of the host", - "name": "hostid", + "description": "the date this template was removed", + "name": "removed", + "type": "date" + }, + { + "description": "the project id of the template", + "name": "projectid", "type": "string" }, - {}, { - "description": "the operation result description", - "name": "description", + "description": "the account name to which the template belongs", + "name": "account", "type": "string" }, { - "description": "the out-of-band management driver for the host", - "name": "driver", + "description": "the template name", + "name": "name", "type": "string" }, - {}, { - "description": "the out-of-band management interface username", - "name": "username", + "description": "the URL which the template/iso is registered from", + "name": "url", "type": "string" }, { - "description": "the out-of-band management interface address", - "name": "address", + "description": "the status of the template", + "name": "status", "type": "string" }, { - "description": "the out-of-band management interface port", - "name": "port", + "description": "true if the template is ready to be deployed from, false otherwise.", + "name": "isready", + "type": "boolean" + }, + { + "description": "true if the template is managed across all Zones, false otherwise", + "name": "crossZones", + "type": "boolean" + }, + { + "description": "the ID of the zone for this template", + "name": "zoneid", "type": "string" }, { @@ -38425,81 +39816,99 @@ "type": "integer" }, { - "description": "the operation result", - "name": "status", + "description": "checksum of the template", + "name": "checksum", + "type": "string" + }, + {}, + { + "description": "true if the template is extractable, false otherwise", + "name": "isextractable", "type": "boolean" }, { - "description": "the out-of-band management interface password", - "name": "password", + "description": "the processor bit size", + "name": "bits", + "type": "int" + }, + { + "description": "the ID of the secondary storage host for the template", + "name": "hostid", "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" } - ], - "since": "4.9.0" + ] }, { - "description": "Issues a client certificate using configured or provided CA plugin", + "description": "Dedicates a zones.", "isasync": true, - "name": "issueCertificate", + "name": "dedicateZone", "params": [ { - "description": "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 ID of the containing domain", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains", + "required": true, + "type": "uuid" }, { - "description": "Certificate validity duration in number of days, when not provided the default configured value will be used", + "description": "the ID of the zone", "length": 255, - "name": "duration", - "required": false, - "type": "integer" + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": true, + "type": "uuid" }, { - "description": "Name of the CA service provider, otherwise the default configured provider plugin will be used", + "description": "the name of the account which needs dedication. Must be used with domainId.", "length": 255, - "name": "provider", + "name": "account", "required": false, "type": "string" + } + ], + "related": "", + "response": [ + { + "description": "the ID of the dedicated resource", + "name": "id", + "type": "string" }, + {}, { - "description": "Comma separated list of IP addresses, the certificate should be issued for", - "length": 255, - "name": "ipaddress", - "required": false, + "description": "the Dedication Affinity Group ID of the zone", + "name": "affinitygroupid", "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": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" - } - ], - "related": "listCaCertificate", - "response": [ - {}, + }, { - "description": "Private key for the certificate", - "name": "privatekey", + "description": "the Account Id to which the Zone is dedicated", + "name": "accountid", "type": "string" }, { - "description": "The client certificate", - "name": "certificate", + "description": "the Name of the Zone", + "name": "zonename", "type": "string" }, - {}, { - "description": "The CA certificate(s)", - "name": "cacertificates", + "description": "the domain ID to which the Zone 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 Zone", + "name": "zoneid", "type": "string" }, { @@ -38507,37 +39916,47 @@ "name": "jobstatus", "type": "integer" } - ], - "since": "4.11.0" + ] }, { - "description": "Deletes network device.", - "isasync": false, - "name": "deleteNetworkDevice", + "description": "Assigns virtual machine or a list of virtual machines to a load balancer rule.", + "isasync": true, + "name": "assignToLoadBalancerRule", "params": [ { - "description": "Id of network device to delete", + "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 ID of the load balancer rule", "length": 255, "name": "id", - "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost,addBaremetalHost", + "related": "createIpv6FirewallRule,updateIpv6FirewallRule,listPortForwardingRules,updatePortForwardingRule", "required": true, "type": "uuid" + }, + { + "description": "the list of IDs of the virtual machine that are being assigned to the load balancer rule(i.e. virtualMachineIds=1,2,3)", + "length": 255, + "name": "virtualmachineids", + "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance", + "required": false, + "type": "list" } ], "response": [ - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, { @@ -38546,258 +39965,309 @@ "type": "boolean" }, {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, {} ] }, { - "description": "Updates image store read-only status", + "description": "Lists all pending asynchronous jobs for the account.", "isasync": false, - "name": "updateImageStore", + "name": "listAsyncJobs", "params": [ { - "description": "Image Store UUID", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "id", - "related": "addSecondaryStorage,listSwifts,updateImageStore,addImageStore,addImageStoreS3,listImageStores,updateCloudToUseObjectStore", - "required": true, + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains", + "required": false, "type": "uuid" }, { - "description": "If set to true, it designates the corresponding image store to read-only, hence not considering them during storage migration", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "readonly", - "required": true, + "name": "isrecursive", + "required": false, "type": "boolean" - } - ], - "related": "addSecondaryStorage,listSwifts,addImageStore,addImageStoreS3,listImageStores,updateCloudToUseObjectStore", - "response": [ - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" }, { - "description": "the Zone name of the image store", - "name": "zonename", + "description": "list resources by account. Must be used with the domainId parameter.", + "length": 255, + "name": "account", + "required": false, "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "length": 255, + "name": "listall", + "required": false, "type": "boolean" }, { - "description": "the name of the image store", - "name": "name", - "type": "string" + "description": "The start date of the async job (use format \"yyyy-MM-dd'T'HH:mm:ss'+'SSSS\")", + "length": 255, + "name": "startdate", + "required": false, + "type": "tzdate" }, { - "description": "the protocol of the image store", - "name": "protocol", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "defines if store is read-only", - "name": "readonly", - "type": "boolean" + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "the ID of the image store", - "name": "id", + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + } + ], + "related": "queryAsyncJobResult", + "response": [ + {}, + { + "description": "the async command executed", + "name": "cmd", "type": "string" }, { - "description": "the host's currently used disk size", - "name": "disksizeused", - "type": "long" + "description": "the result type", + "name": "jobresulttype", + "type": "string" }, { - "description": "the total disk size of the host", - "name": "disksizetotal", - "type": "long" + "description": " the created date of the job", + "name": "created", + "type": "date" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the unique ID of the instance/entity object related to the job", + "name": "jobinstanceid", "type": "string" }, {}, { - "description": "the url of the image store", - "name": "url", - "type": "string" - }, - { - "description": "the provider name of the image store", - "name": "providername", - "type": "string" + "description": "the result reason", + "name": "jobresult", + "type": "responseobject" }, { - "description": "the Zone ID of the image store", - "name": "zoneid", + "description": "the instance/entity object related to the job", + "name": "jobinstancetype", "type": "string" }, { - "description": "the scope of the image store", - "name": "scope", - "type": "scopetype" + "description": "the result code for the job", + "name": "jobresultcode", + "type": "integer" }, - {} - ], - "since": "4.15.0" - }, - { - "description": "Creates a port forwarding rule", - "isasync": true, - "name": "createPortForwardingRule", - "params": [ { - "description": "the ID of the virtual machine for the port forwarding rule", - "length": 255, - "name": "virtualmachineid", - "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance", - "required": true, - "type": "uuid" + "description": " the completed date of the job", + "name": "completed", + "type": "date" }, { - "description": "the starting port of port forwarding rule's private port range", - "length": 255, - "name": "privateport", - "required": true, + "description": "the progress information of the PENDING job", + "name": "jobprocstatus", "type": "integer" }, { - "description": "the IP address id of the port forwarding rule", - "length": 255, - "name": "ipaddressid", - "related": "associateIpAddress,updateIpAddress,associateIpAddress,listPublicIpAddresses", - "required": true, - "type": "uuid" + "description": "the 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", - "length": 255, - "name": "privateendport", - "required": false, + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": "the network of the virtual machine the port forwarding rule will be created for. Required when public IP address is not associated with any guest network yet (VPC case).", - "length": 255, - "name": "networkid", - "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listF5LoadBalancerNetworks,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listSrxFirewallNetworks,listBrocadeVcsDeviceNetworks", - "required": false, - "type": "uuid" + "description": "the account that executed the async command", + "name": "accountid", + "type": "string" }, { - "description": "the protocol for the port forwarding rule. Valid values are TCP or UDP.", - "length": 255, - "name": "protocol", - "required": true, - "type": "string" + "description": "the current job status-should be 0 for PENDING", + "name": "jobstatus", + "type": "integer" }, { - "description": "an optional field, whether to the display the rule to the end user or not", + "description": "the user that executed the async command", + "name": "userid", + "type": "string" + } + ] + }, + { + "description": "Archive one or more alerts.", + "isasync": false, + "name": "archiveAlerts", + "params": [ + { + "description": "start date range to archive alerts (including) this date (use format \"yyyy-MM-dd\" or the new format \"yyyy-MM-ddThh:mm:ss\")", "length": 255, - "name": "fordisplay", + "name": "startdate", "required": false, - "since": "4.4", - "type": "boolean" + "type": "date" }, { - "description": "VM guest nic secondary IP address for the port forwarding rule", + "description": "archive by alert type", "length": 255, - "name": "vmguestip", + "name": "type", "required": false, "type": "string" }, { - "description": "the starting port of port forwarding rule's public port range", + "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": "publicport", - "required": true, - "type": "integer" + "name": "enddate", + "required": false, + "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.", + "description": "the IDs of the alerts", "length": 255, - "name": "cidrlist", + "name": "ids", + "related": "listAlerts", "required": false, "type": "list" + } + ], + "response": [ + {}, + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "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, + "description": "true if operation is executed successfully", + "name": "success", "type": "boolean" }, + {}, { - "description": "the ending port of port forwarding rule's private port range", - "length": 255, - "name": "publicendport", - "required": false, + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" } + ] + }, + { + "description": "Deletes a Cisco Vnmc controller", + "isasync": false, + "name": "deleteCiscoVnmcResource", + "params": [ + { + "description": "Cisco Vnmc resource ID", + "length": 255, + "name": "resourceid", + "related": "listCiscoVnmcResources", + "required": true, + "type": "uuid" + } ], - "related": "listPortForwardingRules,updatePortForwardingRule", "response": [ { - "description": "the protocol of the port forwarding rule", - "name": "protocol", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, {}, - {}, { - "description": "the ID of the port forwarding rule", - "name": "id", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, { - "description": "the VM display name for the port forwarding rule", - "name": "virtualmachinedisplayname", - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, + {}, { - "description": "the VM name for the port forwarding rule", - "name": "virtualmachinename", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "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 public ip address id for the port forwarding rule", - "name": "ipaddressid", + "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 router", + "name": "id", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the project name of the address", + "name": "project", + "type": "string" }, { - "description": "the state of the rule", - "name": "state", + "description": "the public IP address for the router", + "name": "publicip", "type": "string" }, { - "description": "the public ip address for the port forwarding rule", - "name": "ipaddress", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, + {}, { - "description": "the vm ip address for the port forwarding rule", - "name": "vmguestip", + "description": "the name of the router", + "name": "name", "type": "string" }, { - "description": "the starting port of port forwarding rule's public port range", - "name": "publicport", + "description": "the public netmask for the router", + "name": "publicnetmask", "type": "string" }, { - "description": "the ending port of port forwarding rule's private port range", - "name": "privateendport", + "description": "the Pod name for the router", + "name": "podname", "type": "string" }, { @@ -38806,544 +40276,514 @@ "type": "string" }, { - "description": "the VM ID for the port forwarding rule", - "name": "virtualmachineid", + "description": "the domain associated with the router", + "name": "domain", "type": "string" }, { - "description": "the starting port of port forwarding rule's private port range", - "name": "privateport", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, { - "description": "the id of the guest network the port forwarding rule belongs to", - "name": "networkid", + "description": "the version of the code / software in the router", + "name": "softwareversion", "type": "string" }, { - "description": "is firewall for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "the hostname for the router", + "name": "hostname", + "type": "string" }, { - "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", + "description": "the link local MAC address for the router", + "name": "linklocalmacaddress", "type": "string" }, { - "description": "the ending port of port forwarding rule's private port range", - "name": "publicendport", + "description": "the ID of the corresponding link local network", + "name": "linklocalnetworkid", "type": "string" }, { - "description": "the list of resource tags associated with the rule", - "name": "tags", + "description": "the template ID for the router", + "name": "templateid", + "type": "string" + }, + { + "description": "the list of nics associated with the router", + "name": "nic", "response": [ { - "description": "tag key name", - "name": "key", + "description": "the type of the nic", + "name": "type", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the traffic type of the nic", + "name": "traffictype", "type": "string" }, { - "description": "tag value", - "name": "value", + "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 ip address of the nic", + "name": "ipaddress", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "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": "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 isolated private VLAN type if available", + "name": "isolatedpvlantype", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "true if nic is default, false otherwise", + "name": "macaddress", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the name of the corresponding network", + "name": "networkname", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the netmask of the nic", + "name": "netmask", + "type": "string" + }, + { + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", + "type": "string" + }, + { + "description": "the ID of the nic", + "name": "id", + "type": "string" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" + }, + { + "description": "the IPv6 address of network", + "name": "ip6address", + "type": "string" + }, + { + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" + }, + { + "description": "the ID of the corresponding network", + "name": "networkid", + "type": "string" + }, + { + "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 isolation uri of the nic", + "name": "isolationuri", + "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": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + }, + { + "description": "the broadcast uri of the nic", + "name": "broadcasturi", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", "type": "string" } ], - "type": "list" - } - ] - }, - { - "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 name of the account which needs dedication. Must be used with domainId.", - "length": 255, - "name": "account", - "required": false, - "type": "string" - }, - { - "description": "the ID of the containing domain", - "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains", - "required": true, - "type": "uuid" - } - ], - "related": "", - "response": [ - { - "description": "the Name of the Zone", - "name": "zonename", - "type": "string" + "type": "set" }, { - "description": "the Dedication Affinity Group ID of the zone", - "name": "affinitygroupid", + "description": "the first DNS for the router", + "name": "dns1", "type": "string" }, { - "description": "the Account Id to which the Zone is dedicated", - "name": "accountid", + "description": "the name of the corresponding guest network", + "name": "guestnetworkname", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the name of VPC the router belongs to", + "name": "vpcname", "type": "string" }, { - "description": "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 to which the Zone is dedicated", + "description": "the domain ID associated with the router", "name": "domainid", "type": "string" }, { - "description": "the ID of the Zone", - "name": "zoneid", + "description": "the guest MAC address for the router", + "name": "guestmacaddress", "type": "string" }, { - "description": "the ID of the dedicated resource", - "name": "id", + "description": "the Zone name for the router", + "name": "zonename", "type": "string" }, - {} - ] - }, - { - "description": "load template into primary storage", - "isasync": false, - "name": "prepareTemplate", - "params": [ - { - "description": "template ID of the template to be prepared in primary storage(s).", - "length": 255, - "name": "templateid", - "related": "prepareTemplate,listIsos,registerIso,copyTemplate,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", - "required": true, - "type": "uuid" - }, - { - "description": "storage pool ID of the primary storage pool to which the template should be prepared. If it is not provided the template is prepared on all the available primary storage pools.", - "length": 255, - "name": "storageid", - "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities", - "required": false, - "type": "uuid" - }, - { - "description": "zone ID of the template to be prepared in primary storage(s).", - "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", - "response": [ { - "description": "the type of the template", - "name": "templatetype", - "type": "string" + "description": "true if the router template requires upgrader", + "name": "requiresupgrade", + "type": "boolean" }, { - "description": "the template ID of the parent template if present", - "name": "sourcetemplateid", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "true if this template is a featured template, false otherwise", - "name": "isfeatured", - "type": "boolean" + "description": "Last executed health check result for the router", + "name": "healthcheckresults", + "response": [ + { + "description": "result of the health check", + "name": "success", + "type": "boolean" + }, + { + "description": "the name of the health check on the router", + "name": "checkname", + "type": "string" + }, + { + "description": "the type of the health check - basic or advanced", + "name": "checktype", + "type": "string" + }, + { + "description": "detailed response generated on running health check", + "name": "details", + "type": "string" + }, + { + "description": "the date this VPC was created", + "name": "lastupdated", + "type": "date" + } + ], + "type": "list" }, { - "description": "the project name of the template", - "name": "project", + "description": "role of the domain router", + "name": "role", "type": "string" }, { - "description": "the template display text", - "name": "displaytext", + "description": "the first IPv6 DNS for the router", + "name": "ip6dns1", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the ID of the corresponding guest network", + "name": "guestnetworkid", "type": "string" }, { - "description": "the ID of the domain to which the template belongs", - "name": "domainid", + "description": "the state of redundant virtual router", + "name": "redundantstate", "type": "string" }, { - "description": "true if the template is extractable, false otherwise", - "name": "isextractable", - "type": "boolean" - }, - { - "description": "the tag of this template", - "name": "templatetag", + "description": "the ID of the corresponding public network", + "name": "publicnetworkid", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", - "name": "isdynamicallyscalable", - "type": "boolean" - }, - { - "description": "VMware only: additional key/value details tied with deploy-as-is template", - "name": "deployasisdetails", - "type": "map" + "description": "the Pod ID for the router", + "name": "podid", + "type": "string" }, - {}, { - "description": "true if the template is ready to be deployed from, false otherwise.", - "name": "isready", - "type": "boolean" + "description": "the guest IP address for the router", + "name": "guestipaddress", + "type": "string" }, { - "description": "true if template is sshkey enabled, false otherwise", - "name": "sshkeyenabled", + "description": "true if any health checks had failed", + "name": "healthchecksfailed", "type": "boolean" }, { - "description": "true if the ISO is bootable, false otherwise", - "name": "bootable", + "description": "if this router is an redundant virtual router", + "name": "isredundantrouter", "type": "boolean" }, { - "description": "the name of the zone for this template", - "name": "zonename", + "description": "the template name for the router", + "name": "templatename", "type": "string" }, { - "description": "true if this template is a public template, false otherwise", - "name": "ispublic", - "type": "boolean" - }, - { - "description": "the template ID", - "name": "id", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, { - "description": "the ID of the secondary storage host for the template", - "name": "hostid", + "description": "the link local IP address for the router", + "name": "linklocalip", "type": "string" }, { - "description": "checksum of the template", - "name": "checksum", + "description": "VPC the router belongs to", + "name": "vpcid", "type": "string" }, { - "description": "the account id to which the template belongs", - "name": "accountid", + "description": "the second IPv6 DNS for the router", + "name": "ip6dns2", "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 ID of the OS type for this template.", - "name": "ostypeid", + "description": "the version of template", + "name": "version", "type": "string" }, { - "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": "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": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the date this template was removed", - "name": "removed", - "type": "date" - }, - { - "description": "true if template requires HVM enabled, false otherwise", - "name": "requireshvm", - "type": "boolean" - }, - { - "description": "the template name", - "name": "name", + "description": "the project id of the ipaddress", + "name": "projectid", "type": "string" }, { - "description": "the physical size of the template", - "name": "physicalsize", - "type": "long" - }, - { - "description": "Lists the download progress of a template across all secondary storages", - "name": "downloaddetails", - "type": "list" + "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 account associated with the router", + "name": "account", + "type": "string" }, { - "description": "the status of the template", - "name": "status", + "description": "the Zone ID for the router", + "name": "zoneid", "type": "string" }, { - "description": "the account name to which the template belongs", - "name": "account", + "description": "the network domain for the router", + "name": "networkdomain", "type": "string" }, { - "description": "the name of the secondary storage host for the template", - "name": "hostname", + "description": "the version of scripts", + "name": "scriptsversion", "type": "string" }, { - "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", - "name": "directdownload", - "type": "boolean" + "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 second DNS for the router", + "name": "dns2", "type": "string" }, { - "description": "true if the template is managed across all Zones, false otherwise", - "name": "crossZones", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the size of the template", - "name": "size", - "type": "long" + "description": "the link local netmask for the router", + "name": "linklocalnetmask", + "type": "string" }, { - "description": "the format of the template.", - "name": "format", - "type": "imageformat" + "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 host ID for the router", + "name": "hostid", "type": "string" }, { - "description": "the name of the domain to which the template belongs", - "name": "domain", + "description": "the public MAC address for the router", + "name": "publicmacaddress", "type": "string" - }, + } + ] + }, + { + "description": "Adds a Brocade VCS Switch", + "isasync": true, + "name": "addBrocadeVcsDevice", + "params": [ { - "description": "the URL which the template/iso is registered from", - "name": "url", + "description": "Credentials to access the Brocade VCS Switch API", + "length": 255, + "name": "password", + "required": true, "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": "Hostname of ip address of the Brocade VCS Switch.", + "length": 255, + "name": "hostname", + "required": true, + "type": "string" }, { - "description": "additional key/value details tied with template", - "name": "details", - "type": "map" + "description": "Credentials to access the Brocade VCS Switch API", + "length": 255, + "name": "username", + "required": true, + "type": "string" }, { - "description": "if Datadisk template, then id of the root disk template this template belongs to", - "name": "parenttemplateid", + "description": "the Physical Network ID", + "length": 255, + "name": "physicalnetworkid", + "related": "createPhysicalNetwork", + "required": true, + "type": "uuid" + } + ], + "related": "listBrocadeVcsDevices", + "response": [ + { + "description": "the physical Network to which this Brocade VCS belongs to", + "name": "physicalnetworkid", "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 processor bit size", - "name": "bits", - "type": "int" + "description": "device id of the Brocade Vcs", + "name": "vcsdeviceid", + "type": "string" }, { - "description": "the ID of the zone for this template", - "name": "zoneid", + "description": "the principal switch Ip address", + "name": "hostname", "type": "string" }, { - "description": "the project id of the template", - "name": "projectid", + "description": "name of the provider", + "name": "provider", "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": "device name", + "name": "brocadedevicename", + "type": "string" } ] }, { - "description": "Assigns virtual machine or a list of virtual machines to a load balancer rule.", - "isasync": true, - "name": "assignToLoadBalancerRule", + "description": "Updates a security group", + "isasync": false, + "name": "updateSecurityGroup", "params": [ { - "description": "the ID of the load balancer rule", + "description": "The ID of the security group.", "length": 255, "name": "id", - "related": "listPortForwardingRules,updatePortForwardingRule", + "related": "createSecurityGroup,updateSecurityGroup", "required": true, "type": "uuid" }, { - "description": "VM ID and IP map, vmidipmap[0].vmid=1 vmidipmap[0].ip=10.1.1.75", + "description": "The new name of the security group.", "length": 255, - "name": "vmidipmap", + "name": "name", "required": false, - "since": "4.4", - "type": "map" + "type": "string" }, { - "description": "the list of IDs of the virtual machine that are being assigned to the load balancer rule(i.e. virtualMachineIds=1,2,3)", + "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", "length": 255, - "name": "virtualmachineids", - "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance", + "name": "customid", "required": false, - "type": "list" + "since": "4.4", + "type": "string" } ], + "related": "createSecurityGroup", "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", @@ -39351,758 +40791,764 @@ "type": "integer" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the name of the security group", + "name": "name", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the project id of the group", + "name": "projectid", "type": "string" - } - ] - }, - { - "description": "Lists all pending asynchronous jobs for the account.", - "isasync": false, - "name": "listAsyncJobs", - "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": "the ID of the security group", + "name": "id", + "type": "string" }, { - "description": "The start date of the async job (use format \"yyyy-MM-dd'T'HH:mm:ss'+'SSSS\")", - "length": 255, - "name": "startdate", - "required": false, - "type": "tzdate" + "description": "the account owning the security group", + "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 list of egress rules associated with the security group", + "name": "egressrule", + "response": [ + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "account owning the security group rule", + "name": "account", + "type": "string" + }, + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + } + ], + "type": "set" }, { - "description": "list resources by account. Must be used with the domainId parameter.", - "length": 255, - "name": "account", - "required": false, + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" + }, + { + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" + }, + { + "description": "the domain ID of the security group", + "name": "domainid", "type": "string" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" + "description": "the domain name of the security group", + "name": "domain", + "type": "string" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "", + "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 ingress rules associated with the security group", + "name": "ingressrule", + "response": [ + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "account owning the security group rule", + "name": "account", + "type": "string" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + } + ], + "type": "set" + }, + {} + ], + "since": "4.14.0.0" + }, + { + "description": "Creates a domain", + "isasync": false, + "name": "createDomain", + "params": [ + { + "description": "Domain UUID, required for adding domain from another Region", "length": 255, - "name": "pagesize", + "name": "domainid", "required": false, - "type": "integer" + "type": "string" }, { - "description": "list only resources belonging to the domain specified", + "description": "assigns new domain a parent domain by domain ID of the parent. If no parent domain is specied, the ROOT domain is assumed.", "length": 255, - "name": "domainid", + "name": "parentdomainid", "related": "createDomain,listDomainChildren,listDomains,listDomains", "required": false, "type": "uuid" - } - ], - "related": "queryAsyncJobResult", - "response": [ - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" }, { - "description": "the async command executed", - "name": "cmd", + "description": "Network domain for networks in the domain", + "length": 255, + "name": "networkdomain", + "required": false, "type": "string" }, { - "description": "the result code for the job", - "name": "jobresultcode", - "type": "integer" - }, + "description": "creates domain with this name", + "length": 255, + "name": "name", + "required": true, + "type": "string" + } + ], + "related": "listDomainChildren,listDomains,listDomains", + "response": [ { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the total number of vpcs owned by domain", + "name": "vpctotal", + "type": "long" }, { - "description": " the created date of the job", - "name": "created", - "type": "date" + "description": "whether the domain has one or more sub-domains", + "name": "haschild", + "type": "boolean" }, - {}, { - "description": "the result type", - "name": "jobresulttype", + "description": "the total number of snapshots available for this domain", + "name": "snapshotavailable", "type": "string" }, { - "description": "the current job status-should be 0 for PENDING", - "name": "jobstatus", + "description": "the level of the domain", + "name": "level", "type": "integer" }, { - "description": "the unique ID of the instance/entity object related to the job", - "name": "jobinstanceid", + "description": "the total number of cpu cores the domain can own", + "name": "cpulimit", "type": "string" }, { - "description": "the result reason", - "name": "jobresult", - "type": "responseobject" + "description": "the total number of snapshots stored by this domain", + "name": "snapshottotal", + "type": "long" }, { - "description": "the account that executed the async command", - "name": "accountid", + "description": "the total number of vpcs the domain can own", + "name": "vpclimit", "type": "string" }, { - "description": "the instance/entity object related to the job", - "name": "jobinstancetype", + "description": "the domain ID of the parent domain", + "name": "parentdomainid", "type": "string" }, { - "description": "the progress information of the PENDING job", - "name": "jobprocstatus", - "type": "integer" - }, - { - "description": "the user that executed the async command", - "name": "userid", + "description": "the total number of vpcs available to be created for this domain", + "name": "vpcavailable", "type": "string" }, - {}, - { - "description": " the completed date of the job", - "name": "completed", - "type": "date" - } - ] - }, - { - "description": "Archive one or more alerts.", - "isasync": false, - "name": "archiveAlerts", - "params": [ { - "description": "archive by alert type", - "length": 255, - "name": "type", - "required": false, + "description": "the total number of virtual machines available for this domain to acquire", + "name": "vmavailable", "type": "string" }, { - "description": "the IDs of the alerts", - "length": 255, - "name": "ids", - "related": "listAlerts", - "required": false, - "type": "list" - }, - { - "description": "end date range to archive alerts (including) this date (use format \"yyyy-MM-dd\" or the new format \"yyyy-MM-ddThh:mm:ss\")", - "length": 255, - "name": "enddate", - "required": false, - "type": "date" - }, - { - "description": "start date range to archive alerts (including) this date (use format \"yyyy-MM-dd\" or the new format \"yyyy-MM-ddThh:mm:ss\")", - "length": 255, - "name": "startdate", - "required": false, - "type": "date" - } - ], - "response": [ - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the total number of templates which can be created by this domain", + "name": "templatelimit", "type": "string" }, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, - {}, - { - "description": "any text associated with the success or failure", - "name": "displaytext", + "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": "Updates a backup offering.", - "isasync": false, - "name": "updateBackupOffering", - "params": [ - { - "description": "The name of the Backup Offering to be updated", - "length": 255, - "name": "name", - "required": false, - "type": "string" + "description": "the total number of public ip addresses allocated for this domain", + "name": "iptotal", + "type": "long" }, { - "description": "The description of the Backup Offering to be updated", - "length": 255, - "name": "description", - "required": false, - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "The ID of the Backup Offering to be updated", - "length": 255, - "name": "id", - "related": "listBackupProviderOfferings,importBackupOffering,updateBackupOffering", - "required": true, - "type": "uuid" - } - ], - "related": "listBackupProviderOfferings,importBackupOffering", - "response": [ - { - "description": "ID of the backup offering", - "name": "id", + "description": "the total primary storage space (in GiB) available to be used for this domain", + "name": "primarystorageavailable", "type": "string" }, - { - "description": "whether offering allows user driven ad-hoc/scheduled backups", - "name": "allowuserdrivenbackups", - "type": "boolean" - }, {}, { - "description": "zone ID", - "name": "zoneid", - "type": "string" - }, - { - "description": "zone name", - "name": "zonename", + "description": "the total number of networks the domain can own", + "name": "networklimit", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the network domain", + "name": "networkdomain", "type": "string" }, { - "description": "external ID on the provider side", - "name": "externalid", - "type": "string" + "description": "the total number of cpu cores owned by domain", + "name": "cputotal", + "type": "long" }, { - "description": "the date this backup offering was created", + "description": "the date when this domain was created", "name": "created", "type": "date" }, - {}, { - "description": "description for the backup offering", - "name": "description", + "description": "the total volume available for this domain", + "name": "volumeavailable", "type": "string" }, { - "description": "name for the backup offering", - "name": "name", - "type": "string" + "description": "the total number of virtual machines deployed by this domain", + "name": "vmtotal", + "type": "long" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - } - ], - "since": "4.16.0" - }, - { - "description": "Deletes a Cisco Vnmc controller", - "isasync": false, - "name": "deleteCiscoVnmcResource", - "params": [ - { - "description": "Cisco Vnmc resource ID", - "length": 255, - "name": "resourceid", - "related": "listCiscoVnmcResources", - "required": true, - "type": "uuid" - } - ], - "response": [ - { - "description": "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 domain", + "name": "secondarystoragetotal", + "type": "float" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the total number of cpu cores available to be created for this domain", + "name": "cpuavailable", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - {}, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, - {} - ] - }, - { - "description": "Stops an Internal LB vm.", - "isasync": true, - "name": "stopInternalLoadBalancerVM", - "params": [ - { - "description": "the ID of the internal lb vm", - "length": 255, + "description": "the ID of the domain", "name": "id", - "related": "destroyRouter,listRouters,changeServiceForRouter,stopInternalLoadBalancerVM,listInternalLoadBalancerVMs", - "required": true, - "type": "uuid" + "type": "string" }, { - "description": "Force stop the VM. The caller knows the VM is stopped.", - "length": 255, - "name": "forced", - "required": false, - "type": "boolean" - } - ], - "related": "destroyRouter,listRouters,changeServiceForRouter,listInternalLoadBalancerVMs", - "response": [ + "description": "details for the domain", + "name": "domaindetails", + "type": "map" + }, { - "description": "the template name for the router", - "name": "templatename", + "description": "the name of the domain", + "name": "name", "type": "string" }, { - "description": "the guest IP address for the router", - "name": "guestipaddress", + "description": "the total number of public ip addresses available for this domain to acquire", + "name": "ipavailable", "type": "string" }, { - "description": "the account associated with the router", - "name": "account", + "description": "the total number of projects available for administration by this domain", + "name": "projectavailable", "type": "string" }, { - "description": "the public IP address for the router", - "name": "publicip", + "description": "the total number of templates available to be created by this domain", + "name": "templateavailable", "type": "string" }, { - "description": "the name of the router", - "name": "name", - "type": "string" + "description": "the total volume being used by this domain", + "name": "volumetotal", + "type": "long" }, { - "description": "role of the domain router", - "name": "role", + "description": "the domain name of the parent domain", + "name": "parentdomainname", "type": "string" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "the total primary storage space (in GiB) the domain can own", + "name": "primarystoragelimit", "type": "string" }, { - "description": "the network domain for the router", - "name": "networkdomain", - "type": "string" + "description": "the total memory (in MB) owned by domain", + "name": "memorytotal", + "type": "long" }, { - "description": "the domain ID associated with the router", - "name": "domainid", + "description": "the total secondary storage space (in GiB) the domain can own", + "name": "secondarystoragelimit", "type": "string" }, { - "description": "VPC the router belongs to", - "name": "vpcid", + "description": "the total memory (in MB) the domain can own", + "name": "memorylimit", "type": "string" }, { - "description": "the guest netmask for the router", - "name": "guestnetmask", + "description": "the total secondary storage space (in GiB) available to be used for this domain", + "name": "secondarystorageavailable", "type": "string" }, { - "description": "the version of scripts", - "name": "scriptsversion", + "description": "the total number of virtual machines that can be deployed by this domain", + "name": "vmlimit", "type": "string" }, { - "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 Zone ID for the router", - "name": "zoneid", - "type": "string" + "description": "the total number of templates which have been created by this domain", + "name": "templatetotal", + "type": "long" }, { - "description": "the guest MAC address for the router", - "name": "guestmacaddress", + "description": "the total number of public ip addresses this domain can acquire", + "name": "iplimit", "type": "string" }, { - "description": "the template ID for the router", - "name": "templateid", - "type": "string" + "description": "the total number of networks owned by domain", + "name": "networktotal", + "type": "long" }, { - "description": "the domain associated with the router", - "name": "domain", - "type": "string" + "description": "the total primary storage space (in GiB) owned by domain", + "name": "primarystoragetotal", + "type": "long" }, { - "description": "the version of template", - "name": "version", + "description": "the total volume which can be used by this domain", + "name": "volumelimit", "type": "string" }, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the ID of the corresponding guest network", - "name": "guestnetworkid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the Zone name for the router", - "name": "zonename", + "description": "the total number of snapshots which can be stored by this domain", + "name": "snapshotlimit", "type": "string" }, { - "description": "the second IPv6 DNS for the router", - "name": "ip6dns2", + "description": "the total number of projects the domain can own", + "name": "projectlimit", "type": "string" }, { - "description": "the state of redundant virtual router", - "name": "redundantstate", + "description": "the state of the domain", + "name": "state", "type": "string" }, { - "description": "the link local netmask for the router", - "name": "linklocalnetmask", + "description": "the total memory (in MB) available to be created for this domain", + "name": "memoryavailable", "type": "string" }, + {}, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", - "type": "string" + "description": "the total number of projects being administrated by this domain", + "name": "projecttotal", + "type": "long" }, { - "description": "the project name of the address", - "name": "project", + "description": "the total number of networks available to be created for this domain", + "name": "networkavailable", "type": "string" - }, - {}, + } + ] + }, + { + "description": "Deleting resource tag(s)", + "isasync": true, + "name": "deleteTags", + "params": [ { - "description": "the first IPv6 DNS for the router", - "name": "ip6dns1", - "type": "string" + "description": "Delete tags for resource id(s)", + "length": 255, + "name": "resourceids", + "required": true, + "type": "list" }, { - "description": "the link local MAC address for the router", - "name": "linklocalmacaddress", - "type": "string" + "description": "Delete tags matching key/value pairs", + "length": 255, + "name": "tags", + "required": false, + "type": "map" }, { - "description": "the host ID for the router", - "name": "hostid", + "description": "Delete tag by resource type", + "length": 255, + "name": "resourcetype", + "required": true, "type": "string" - }, + } + ], + "response": [ { - "description": "true if the router template requires upgrader", - "name": "requiresupgrade", + "description": "true if operation is executed successfully", + "name": "success", "type": "boolean" }, + {}, { - "description": "the project id of the ipaddress", - "name": "projectid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the public MAC address for the router", - "name": "publicmacaddress", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "if this router is an redundant virtual router", - "name": "isredundantrouter", - "type": "boolean" - }, - { - "description": "the hostname for the router", - "name": "hostname", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, + {} + ], + "since": "4.0.0" + }, + { + "description": "List external firewall appliances.", + "isasync": false, + "name": "listExternalFirewalls", + "params": [ { - "description": "Last executed health check result for the router", - "name": "healthcheckresults", - "response": [ - { - "description": "detailed response generated on running health check", - "name": "details", - "type": "string" - }, - { - "description": "the name of the health check on the router", - "name": "checkname", - "type": "string" - }, - { - "description": "result of the health check", - "name": "success", - "type": "boolean" - }, - { - "description": "the date this VPC was created", - "name": "lastupdated", - "type": "date" - }, - { - "description": "the type of the health check - basic or advanced", - "name": "checktype", - "type": "string" - } - ], - "type": "list" + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" }, { - "description": "the date and time the router was created", - "name": "created", - "type": "date" + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "the state of the router", - "name": "state", - "type": "state" + "description": "zone Id", + "length": 255, + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": true, + "type": "uuid" }, { - "description": "the id of the router", - "name": "id", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" - }, + } + ], + "related": "", + "response": [ { - "description": "the ID of the corresponding link local network", - "name": "linklocalnetworkid", + "description": "the ID of the network device", + "name": "id", "type": "string" }, { - "description": "the link local IP address for the router", - "name": "linklocalip", + "description": "the username that's used to log in to the external firewall", + "name": "username", "type": "string" }, { - "description": "the gateway for the router", - "name": "gateway", + "description": "the public interface of the external firewall", + "name": "publicinterface", "type": "string" }, { - "description": "the ID of the corresponding public network", - "name": "publicnetworkid", + "description": "the usage interface of the external firewall", + "name": "usageinterface", "type": "string" }, { - "description": "the Pod ID for the router", - "name": "podid", + "description": "the ID of the external firewall", + "name": "id", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the timeout (in seconds) for requests to the external firewall", + "name": "timeout", "type": "string" }, { - "description": "the Pod name for the router", - "name": "podname", + "description": "the private security zone of the external firewall", + "name": "privatezone", "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": "the traffic type of the nic", - "name": "traffictype", - "type": "string" - }, - { - "description": "true if nic is default, false otherwise", - "name": "macaddress", - "type": "string" - }, - { - "description": "the gateway of the nic", - "name": "gateway", - "type": "string" - }, - { - "description": "the name of the corresponding network", - "name": "networkname", - "type": "string" - }, - { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", - "type": "string" - }, - { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", - "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": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" - }, - { - "description": "the netmask of the nic", - "name": "netmask", - "type": "string" - }, - { - "description": "Type of adapter if available", - "name": "adaptertype", - "type": "string" - }, - { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", - "type": "string" - }, - { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" - }, - { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - }, - { - "description": "the ID of the nic", - "name": "id", - "type": "string" - }, - { - "description": "the ip address of the nic", - "name": "ipaddress", - "type": "string" - }, - { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", - "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 broadcast uri of the nic", - "name": "broadcasturi", - "type": "string" - }, - { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" - }, - { - "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": "the private interface of the external firewall", + "name": "privateinterface", + "type": "string" }, { "description": "the UUID of the latest async job acting on this object", @@ -40110,340 +41556,254 @@ "type": "string" }, { - "description": "the first DNS for the router", - "name": "dns1", + "description": "the public security zone of the external firewall", + "name": "publiczone", "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": "true if any health checks had failed", - "name": "healthchecksfailed", - "type": "boolean" + "description": "the number of times to retry requests to the external firewall", + "name": "numretries", + "type": "string" }, { - "description": "the second DNS for the router", - "name": "dns2", + "description": "the management IP address of the external firewall", + "name": "ipaddress", "type": "string" }, { - "description": "the name of the corresponding guest network", - "name": "guestnetworkname", + "description": "the zone ID of the external firewall", + "name": "zoneid", "type": "string" - } + }, + {}, + {} ] }, { - "description": "Adds a Brocade VCS Switch", + "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": "addBrocadeVcsDevice", + "name": "restartNetwork", "params": [ { - "description": "Hostname of ip address of the Brocade VCS Switch.", + "description": "The ID of the network to restart.", "length": 255, - "name": "hostname", + "name": "id", + "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listSrxFirewallNetworks,listBrocadeVcsDeviceNetworks", "required": true, - "type": "string" + "type": "uuid" }, { - "description": "Credentials to access the Brocade VCS Switch API", + "description": "If cleanup old network elements", "length": 255, - "name": "username", - "required": true, - "type": "string" + "name": "cleanup", + "required": false, + "type": "boolean" }, { - "description": "Credentials to access the Brocade VCS Switch API", + "description": "Turn the network into a network with redundant routers.", "length": 255, - "name": "password", - "required": true, - "type": "string" + "name": "makeredundant", + "required": false, + "since": "4.11.1", + "type": "boolean" }, { - "description": "the Physical Network ID", + "description": "Live patches the router software before restarting it. This parameter will only work when 'cleanup' is false.", "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork", - "required": true, - "type": "uuid" + "name": "livepatch", + "required": false, + "since": "4.17.0", + "type": "boolean" } ], - "related": "listBrocadeVcsDevices", "response": [ - {}, - { - "description": "device name", - "name": "brocadedevicename", - "type": "string" - }, - { - "description": "device id of the Brocade Vcs", - "name": "vcsdeviceid", - "type": "string" - }, - { - "description": "the physical Network to which this Brocade VCS belongs to", - "name": "physicalnetworkid", - "type": "string" - }, - { - "description": "the principal switch Ip address", - "name": "hostname", - "type": "string" - }, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + {}, + {}, { - "description": "name of the provider", - "name": "provider", + "description": "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": "Updates a security group", + "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": "updateSecurityGroup", + "name": "login", "params": [ { - "description": "The ID of the security 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": "id", - "related": "createSecurityGroup,updateSecurityGroup", + "name": "domain", + "required": false, + "type": "string" + }, + { + "description": "Username", + "length": 255, + "name": "username", "required": true, - "type": "uuid" + "type": "string" }, { - "description": "The new name of the security group.", + "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": "name", - "required": false, + "name": "password", + "required": true, "type": "string" }, { - "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", + "description": "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": "customid", + "name": "domainId", "required": false, - "since": "4.4", - "type": "string" + "type": "long" } ], - "related": "createSecurityGroup", + "related": "", "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 ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, - { - "description": "account owning the security group rule", - "name": "account", - "type": "string" - }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - } - ], - "type": "set" + "description": "user time zone", + "name": "timezone", + "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": "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" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - } - ], - "type": "set" + "description": "the account name the user belongs to", + "name": "account", + "type": "string" + }, + { + "description": "last name of the user", + "name": "lastname", + "type": "string" + }, + { + "description": "the time period before the session has expired", + "name": "timeout", + "type": "integer" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "Session key that can be passed in subsequent Query command calls", + "name": "sessionkey", + "type": "string" + }, + { + "description": "first name of the user", + "name": "firstname", + "type": "string" + }, + { + "description": "Is user registered", + "name": "registered", + "type": "string" }, { - "description": "the description of the security group", - "name": "description", + "description": "Username", + "name": "username", "type": "string" }, { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", + "description": "user time zoneoffset", + "name": "timezoneoffset", + "type": "string" + }, + {}, + { + "description": "Domain ID that the user 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 UUID of the latest async job acting on this object", - "name": "jobid", + "description": "User ID", + "name": "userid", "type": "string" }, + {}, { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" + "description": "the account type (admin, domain-admin, read-only-admin, user)", + "name": "type", + "type": "string" + } + ] + }, + { + "description": "Lists all hypervisor capabilities.", + "isasync": false, + "name": "listHypervisorCapabilities", + "params": [ + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" }, { - "description": "the ID of the security group", + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "description": "ID of the hypervisor capability", + "length": 255, "name": "id", - "type": "string" + "related": "listHypervisorCapabilities", + "required": false, + "type": "uuid" }, { - "description": "the domain ID of the security group", - "name": "domainid", + "description": "the hypervisor for which to restrict the search", + "length": 255, + "name": "hypervisor", + "required": false, "type": "string" }, { - "description": "the domain name of the security group", - "name": "domain", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" + } + ], + "related": "", + "response": [ + { + "description": "the maximum number of Hosts per cluster for this hypervisor", + "name": "maxhostspercluster", + "type": "integer" }, { "description": "the current status of the latest async job acting on this object", @@ -40451,193 +41811,119 @@ "type": "integer" }, { - "description": "the name of the security group", - "name": "name", - "type": "string" + "description": "true if storage motion is supported", + "name": "storagemotionenabled", + "type": "boolean" }, + {}, { - "description": "the project name of the group", - "name": "project", + "description": "the ID of the hypervisor capabilities row", + "name": "id", "type": "string" }, { - "description": "the account owning the security group", - "name": "account", + "description": "true if VM snapshots are enabled for this hypervisor", + "name": "vmsnapshotenabled", + "type": "boolean" + }, + { + "description": "true if security group is supported", + "name": "securitygroupenabled", + "type": "boolean" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, {}, { - "description": "the project id of the group", - "name": "projectid", + "description": "the maximum number of guest vms recommended for this hypervisor", + "name": "maxguestslimit", + "type": "long" + }, + { + "description": "the hypervisor version", + "name": "hypervisorversion", "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 code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "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": "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": "account owning the security group rule", - "name": "account", - "type": "string" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, - { - "description": "the 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 maximum number of Data Volumes that can be attached for this hypervisor", + "name": "maxdatavolumeslimit", + "type": "integer" + }, + { + "description": "the hypervisor type", + "name": "hypervisor", + "type": "hypervisortype" } ], - "since": "4.14.0.0" + "since": "3.0.0" }, { - "description": "Creates a domain", + "description": "Adds backup image store.", "isasync": false, - "name": "createDomain", + "name": "addImageStore", "params": [ { - "description": "Domain UUID, required for adding domain from another Region", + "description": "the image store provider name", "length": 255, - "name": "domainid", - "required": false, + "name": "provider", + "required": true, "type": "string" }, { - "description": "assigns new domain a parent domain by domain ID of the parent. If no parent domain is specied, the ROOT domain is assumed.", + "description": "the name for the image store", "length": 255, - "name": "parentdomainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains", + "name": "name", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "Network domain for networks in the domain", + "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": "networkdomain", + "name": "details", + "required": false, + "type": "map" + }, + { + "description": "the URL for the image store", + "length": 2048, + "name": "url", "required": false, "type": "string" }, { - "description": "creates domain with this name", + "description": "the Zone ID for the image store", "length": 255, - "name": "name", - "required": true, - "type": "string" + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": false, + "type": "uuid" } ], - "related": "listDomainChildren,listDomains,listDomains", + "related": "addSecondaryStorage,listSwifts,addImageStoreS3,listImageStores,updateCloudToUseObjectStore", "response": [ { - "description": "the total number of vpcs available to be created for this domain", - "name": "vpcavailable", + "description": "the Zone name of the image store", + "name": "zonename", "type": "string" }, + {}, { - "description": "the total number of projects the domain can own", - "name": "projectlimit", + "description": "the url of the image store", + "name": "url", "type": "string" }, + {}, { - "description": "the total number of templates which can be created by this domain", - "name": "templatelimit", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the total 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" }, { @@ -40646,548 +41932,826 @@ "type": "integer" }, { - "description": "whether the domain has one or more sub-domains", - "name": "haschild", - "type": "boolean" + "description": "the provider name of the image store", + "name": "providername", + "type": "string" }, { - "description": "the total volume available for this domain", - "name": "volumeavailable", + "description": "the name of the image store", + "name": "name", "type": "string" }, { - "description": "the domain name of the parent domain", - "name": "parentdomainname", - "type": "string" + "description": "defines if store is read-only", + "name": "readonly", + "type": "boolean" }, { - "description": "details for the domain", - "name": "domaindetails", - "type": "map" + "description": "the host's currently used disk size", + "name": "disksizeused", + "type": "long" }, { - "description": "the path of the domain", - "name": "path", + "description": "the ID of the image store", + "name": "id", "type": "string" }, { - "description": "the total secondary storage space (in GiB) owned by domain", - "name": "secondarystoragetotal", - "type": "float" + "description": "the Zone ID of the image store", + "name": "zoneid", + "type": "string" }, { - "description": "the date when this domain was created", - "name": "created", - "type": "date" + "description": "the protocol of the image store", + "name": "protocol", + "type": "string" }, { - "description": "the total number of virtual machines deployed by this domain", - "name": "vmtotal", + "description": "the total disk size of the host", + "name": "disksizetotal", "type": "long" }, { - "description": "the total number of public ip addresses this domain can acquire", - "name": "iplimit", - "type": "string" - }, + "description": "the scope of the image store", + "name": "scope", + "type": "scopetype" + } + ], + "since": "4.2.0" + }, + { + "description": "Revoke a direct download certificate from hosts in a zone", + "isasync": false, + "name": "revokeTemplateDirectDownloadCertificate", + "params": [ { - "description": "the total number of virtual machines available for this domain to acquire", - "name": "vmavailable", + "description": "(optional) hypervisor type", + "length": 255, + "name": "hypervisor", + "required": false, "type": "string" }, { - "description": "the total number of networks owned by domain", - "name": "networktotal", - "type": "long" + "description": "(optional) zone to revoke certificate", + "length": 255, + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": true, + "type": "uuid" }, { - "description": "the name of the domain", + "description": "(optional) alias of the SSL certificate", + "length": 255, "name": "name", + "required": false, "type": "string" }, { - "description": "the total number of snapshots which can be stored by this domain", - "name": "snapshotlimit", - "type": "string" + "description": "id of the certificate", + "length": 255, + "name": "id", + "related": "uploadTemplateDirectDownloadCertificate,listTemplateDirectDownloadCertificates", + "required": false, + "type": "uuid" }, { - "description": "the network domain", - "name": "networkdomain", + "description": "(optional) the host ID to revoke certificate", + "length": 255, + "name": "hostid", + "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost", + "required": false, + "type": "uuid" + } + ], + "related": "provisionTemplateDirectDownloadCertificate", + "response": [ + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the name of the host", + "name": "hostname", "type": "string" }, { - "description": "the total number of virtual machines that can be deployed by this domain", - "name": "vmlimit", + "description": "indicates if the certificate has been revoked from the host, failed or skipped", + "name": "status", "type": "string" }, { - "description": "the total number of cpu cores owned by domain", - "name": "cputotal", - "type": "long" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the total number of templates available to be created by this domain", - "name": "templateavailable", + "description": "indicates the details in case of failure or host skipped", + "name": "details", "type": "string" }, { - "description": "the total number of snapshots stored by this domain", - "name": "snapshottotal", - "type": "long" + "description": "the ID of the host", + "name": "hostid", + "type": "string" }, + {} + ], + "since": "4.13" + }, + { + "description": "Syncs capabilities of storage pools", + "isasync": false, + "name": "updateStorageCapabilities", + "params": [ { - "description": "the total volume being used by this domain", - "name": "volumetotal", + "description": "Storage pool id", + "length": 255, + "name": "id", + "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities", + "required": true, + "type": "uuid" + } + ], + "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool", + "response": [ + { + "description": "the total disk size of the storage pool", + "name": "disksizetotal", "type": "long" }, + {}, { - "description": "the total secondary storage space (in GiB) available to be used for this domain", - "name": "secondarystorageavailable", + "description": "Storage provider for this pool", + "name": "provider", "type": "string" }, - {}, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the name of the cluster for the storage pool", + "name": "clustername", + "type": "string" }, { - "description": "the total number of public ip addresses available for this domain to acquire", - "name": "ipavailable", + "description": "the ID of the cluster for the storage pool", + "name": "clusterid", "type": "string" }, { - "description": "the state of the domain", - "name": "state", + "description": "the name of the storage pool", + "name": "name", "type": "string" }, { - "description": "the total primary storage space (in GiB) owned by domain", - "name": "primarystoragetotal", + "description": "IOPS CloudStack can provision from this storage pool", + "name": "capacityiops", "type": "long" }, { - "description": "the total number of vpcs the domain can own", - "name": "vpclimit", + "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 total number of public ip addresses allocated for this domain", - "name": "iptotal", + "description": "total min IOPS currently in use by volumes", + "name": "allocatediops", "type": "long" }, { - "description": "the ID of the domain", - "name": "id", + "description": "the tags for the storage pool", + "name": "tags", "type": "string" }, { - "description": "the total memory (in MB) owned by domain", - "name": "memorytotal", - "type": "long" + "description": "the Pod name of the storage pool", + "name": "podname", + "type": "string" }, + {}, { - "description": "the total memory (in MB) available to be created for this domain", - "name": "memoryavailable", + "description": "the hypervisor type of the storage pool", + "name": "hypervisor", "type": "string" }, { - "description": "the total number of templates which have been created by this domain", - "name": "templatetotal", - "type": "long" + "description": "the storage pool path", + "name": "path", + "type": "string" }, { - "description": "the total number of snapshots available for this domain", - "name": "snapshotavailable", + "description": "the Zone name of the storage pool", + "name": "zonename", "type": "string" }, { - "description": "the total memory (in MB) the domain can own", - "name": "memorylimit", - "type": "string" + "description": "the host's currently allocated disk size", + "name": "disksizeallocated", + "type": "long" }, { - "description": "the total volume which can be used by this domain", - "name": "volumelimit", + "description": "the overprovisionfactor for the storage pool", + "name": "overprovisionfactor", "type": "string" }, - {}, { - "description": "the level of the domain", - "name": "level", - "type": "integer" + "description": "the Zone ID of the storage pool", + "name": "zoneid", + "type": "string" }, { - "description": "the domain ID of the parent domain", - "name": "parentdomainid", + "description": "the IP address of the storage pool", + "name": "ipaddress", "type": "string" }, { - "description": "the total secondary storage space (in GiB) the domain can own", - "name": "secondarystoragelimit", - "type": "string" + "description": "the state of the storage pool", + "name": "state", + "type": "storagepoolstatus" }, { - "description": "the total number of networks the domain can own", - "name": "networklimit", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the total number of cpu cores the domain can own", - "name": "cpulimit", + "description": "the Pod ID of the storage pool", + "name": "podid", "type": "string" }, { - "description": "the total number of vpcs owned by domain", - "name": "vpctotal", - "type": "long" + "description": "the ID of the storage pool", + "name": "id", + "type": "string" }, { - "description": "the total number of cpu cores available to be created for this domain", - "name": "cpuavailable", - "type": "string" + "description": "the date and time the storage pool was created", + "name": "created", + "type": "date" }, { - "description": "the total primary storage space (in GiB) available to be used for this domain", - "name": "primarystorageavailable", + "description": "the storage pool type", + "name": "type", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "true if this pool is suitable to migrate a volume, false otherwise", + "name": "suitableformigration", "type": "boolean" }, { - "description": "the total number of projects being administrated by this domain", - "name": "projecttotal", + "description": "the host's currently used disk size", + "name": "disksizeused", "type": "long" }, - { - "description": "the total number of projects available for administration by this domain", - "name": "projectavailable", - "type": "string" - }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "the total primary storage space (in GiB) the domain can own", - "name": "primarystoragelimit", - "type": "string" + "description": "the storage pool capabilities", + "name": "storagecapabilities", + "type": "map" } - ] + ], + "since": "4.16.0" }, { - "description": "Deleting resource tag(s)", - "isasync": true, - "name": "deleteTags", + "description": "Delete Project roles in CloudStack", + "isasync": false, + "name": "deleteProjectRole", "params": [ { - "description": "Delete tag by resource type", + "description": "ID of the project role to be deleted", "length": 255, - "name": "resourcetype", + "name": "id", + "related": "createProjectRole,listProjectRoles,updateProjectRole", "required": true, - "type": "string" + "type": "uuid" }, { - "description": "Delete tags for resource id(s)", + "description": "ID of the project from where the role is to be deleted", "length": 255, - "name": "resourceids", + "name": "projectid", + "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", "required": true, - "type": "list" - }, - { - "description": "Delete tags matching key/value pairs", - "length": 255, - "name": "tags", - "required": false, - "type": "map" + "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": "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.0.0" + "since": "4.15.0" }, { - "description": "List external firewall appliances.", + "description": "Get SolidFire Account ID", "isasync": false, - "name": "listExternalFirewalls", + "name": "getSolidFireAccountId", "params": [ { - "description": "zone Id", + "description": "Storage Pool UUID", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "storageid", "required": true, - "type": "uuid" + "type": "string" }, { - "description": "List by keyword", + "description": "CloudStack Account UUID", "length": 255, - "name": "keyword", - "required": false, + "name": "accountid", + "required": true, + "type": "string" + } + ], + "related": "", + "response": [ + { + "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": "", + "description": "SolidFire Account ID", + "name": "solidFireAccountId", + "type": "long" + } + ] + }, + { + "description": "Lists role permissions", + "isasync": false, + "name": "listRolePermissions", + "params": [ + { + "description": "ID of the role", "length": 255, - "name": "page", + "name": "roleid", + "related": "createRole,importRole,listRoles,updateRole", "required": false, - "type": "integer" + "type": "uuid" } ], "related": "", "response": [ - {}, { - "description": "the private security zone of the external firewall", - "name": "privatezone", + "description": "the name of the role to which the role permission belongs", + "name": "rolename", "type": "string" }, { - "description": "the usage interface of the external firewall", - "name": "usageinterface", + "description": "the ID of the role to which the role permission belongs", + "name": "roleid", "type": "string" }, { - "description": "the public security zone of the external firewall", - "name": "publiczone", + "description": "the permission type of the api name or wildcard rule, allow/deny", + "name": "permission", "type": "string" }, { - "description": "the username that's used to log in to the external firewall", - "name": "username", + "description": "the ID of the role permission", + "name": "id", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "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 timeout (in seconds) for requests to the external firewall", - "name": "timeout", + "description": "the description of the role permission", + "name": "description", "type": "string" }, { - "description": "the ID of the external firewall", - "name": "id", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" + } + ], + "since": "4.9.0" + }, + { + "description": "Lists all network services provided by CloudStack or for the given Provider.", + "isasync": false, + "name": "listSupportedNetworkServices", + "params": [ + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "the public interface of the external firewall", - "name": "publicinterface", + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, + { + "description": "network service provider name", + "length": 255, + "name": "provider", + "required": false, "type": "string" }, - {}, { - "description": "the private interface of the external firewall", - "name": "privateinterface", + "description": "network service name to list providers and capabilities of", + "length": 255, + "name": "service", + "required": false, "type": "string" }, { - "description": "the management IP address of the external firewall", - "name": "ipaddress", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" + } + ], + "related": "", + "response": [ + {}, + { + "description": "the list of capabilities", + "name": "capability", + "response": [ + { + "description": "the capability name", + "name": "name", + "type": "string" + }, + { + "description": "the capability value", + "name": "value", + "type": "string" + }, + { + "description": "can this service capability value can be choosable while creatine network offerings", + "name": "canchooseservicecapability", + "type": "boolean" + } + ], + "type": "list" }, { - "description": "the ID of the network device", - "name": "id", + "description": "the service name", + "name": "name", "type": "string" }, + { + "description": "the service provider name", + "name": "provider", + "response": [ + { + "description": "true if individual services can be enabled/disabled", + "name": "canenableindividualservice", + "type": "boolean" + }, + { + "description": "the physical network this belongs to", + "name": "physicalnetworkid", + "type": "string" + }, + { + "description": "the provider name", + "name": "name", + "type": "string" + }, + { + "description": "uuid of the network provider", + "name": "id", + "type": "string" + }, + { + "description": "services for this provider", + "name": "servicelist", + "type": "list" + }, + { + "description": "the destination physical network", + "name": "destinationphysicalnetworkid", + "type": "string" + }, + { + "description": "state of the network provider", + "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 number of times to retry requests to the external firewall", - "name": "numretries", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + } + ], + "since": "3.0.0" + }, + { + "description": "Deletes a particular ingress rule from this security group", + "isasync": true, + "name": "revokeSecurityGroupIngress", + "params": [ + { + "description": "The ID of the ingress rule", + "length": 255, + "name": "id", + "related": "authorizeSecurityGroupIngress", + "required": true, + "type": "uuid" + } + ], + "response": [ + {}, + { + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, { - "description": "the zone ID of the external firewall", - "name": "zoneid", + "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": "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.", + "description": "Lists dedicated guest vlan ranges", "isasync": false, - "name": "login", + "name": "listDedicatedGuestVlanRanges", "params": [ { - "description": "Hashed password (Default is MD5). If you wish to use any other hashing algorithm, you would need to write a custom authentication adapter See Docs section.", + "description": "", "length": 255, - "name": "password", - "required": true, + "name": "page", + "required": false, + "type": "integer" + }, + { + "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": "Path of the domain that the user belongs to. Example: domain=/com/cloud/internal. If no domain is passed in, the ROOT (/) domain is assumed.", + "description": "the dedicated guest vlan range", "length": 255, - "name": "domain", + "name": "guestvlanrange", "required": false, "type": "string" }, { - "description": "The id of the domain that the user belongs to. If both domain and domainId are passed in, \"domainId\" parameter takes precendence", + "description": "", "length": 255, - "name": "domainId", + "name": "pagesize", "required": false, - "type": "long" + "type": "integer" }, { - "description": "Username", + "description": "List by keyword", "length": 255, - "name": "username", - "required": true, + "name": "keyword", + "required": false, "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": "list dedicated guest vlan ranges by id", + "length": 255, + "name": "id", + "related": "listDedicatedGuestVlanRanges", + "required": false, + "type": "uuid" + }, + { + "description": "physical network id of the guest VLAN range", + "length": 255, + "name": "physicalnetworkid", + "related": "createPhysicalNetwork", + "required": false, + "type": "uuid" + }, + { + "description": "zone of the guest VLAN range", + "length": 255, + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": false, + "type": "uuid" + }, + { + "description": "the domain ID with which the guest VLAN range is associated. If used with the account parameter, returns all guest VLAN ranges for that account in the specified domain.", + "length": 255, + "name": "domainid", + "related": "listDomainChildren,listDomains,listDomains", + "required": false, + "type": "uuid" } ], "related": "", "response": [ { - "description": "the time period before the session has expired", - "name": "timeout", + "description": "the guest VLAN range", + "name": "guestvlanrange", + "type": "string" + }, + {}, + { + "description": "the zone of the guest vlan range", + "name": "zoneid", + "type": "long" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the account of the guest VLAN range", + "name": "account", "type": "string" }, { - "description": "user time zoneoffset", - "name": "timezoneoffset", + "description": "the domain ID of the guest VLAN range", + "name": "domainid", "type": "string" }, { - "description": "the account name the user belongs to", - "name": "account", + "description": "the physical network of the guest vlan range", + "name": "physicalnetworkid", + "type": "long" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, { - "description": "Session key that can be passed in subsequent Query command calls", - "name": "sessionkey", + "description": "the ID of the guest VLAN range", + "name": "id", "type": "string" }, { - "description": "Is user registered", - "name": "registered", + "description": "the project id of the guest vlan range", + "name": "projectid", "type": "string" }, - {}, { - "description": "Username", - "name": "username", + "description": "the domain name of the guest VLAN range", + "name": "domain", "type": "string" }, { - "description": "User ID", - "name": "userid", + "description": "the project name of the guest vlan range", + "name": "project", "type": "string" + } + ] + }, + { + "description": "Adds a network serviceProvider to a physical network", + "isasync": true, + "name": "addNetworkServiceProvider", + "params": [ + { + "description": "the destination Physical Network ID to bridge to", + "length": 255, + "name": "destinationphysicalnetworkid", + "related": "createPhysicalNetwork", + "required": false, + "type": "uuid" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the Physical Network ID to add the provider to", + "length": 255, + "name": "physicalnetworkid", + "related": "createPhysicalNetwork", + "required": true, + "type": "uuid" + }, + { + "description": "the name for the physical network service provider", + "length": 255, + "name": "name", + "required": true, + "type": "string" }, { - "description": "first name of the user", - "name": "firstname", + "description": "the list of services to be enabled for this physical network service provider", + "length": 255, + "name": "servicelist", + "required": false, + "type": "list" + } + ], + "related": "listNetworkServiceProviders,listTrafficTypes", + "response": [ + { + "description": "the physical network this belongs to", + "name": "physicalnetworkid", "type": "string" }, + {}, { - "description": "Domain ID that the user belongs to", - "name": "domainid", + "description": "uuid of the network provider", + "name": "id", "type": "string" }, - {}, { - "description": "the account type (admin, domain-admin, read-only-admin, user)", - "name": "type", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "user time zone", - "name": "timezone", + "description": "the provider name", + "name": "name", "type": "string" }, { - "description": "last name of the user", - "name": "lastname", + "description": "state of the network provider", + "name": "state", "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": "If cleanup old network elements", - "length": 255, - "name": "cleanup", - "required": false, - "type": "boolean" }, { - "description": "Turn the network into a network with redundant routers.", - "length": 255, - "name": "makeredundant", - "required": false, - "since": "4.11.1", + "description": "true if individual services can be enabled/disabled", + "name": "canenableindividualservice", "type": "boolean" }, { - "description": "The ID of the network to restart.", - "length": 255, - "name": "id", - "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listF5LoadBalancerNetworks,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listSrxFirewallNetworks,listBrocadeVcsDeviceNetworks", - "required": true, - "type": "uuid" - } - ], - "response": [ - {}, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "the destination physical network", + "name": "destinationphysicalnetworkid", + "type": "string" }, {}, { @@ -41196,1197 +42760,1192 @@ "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": "services for this provider", + "name": "servicelist", + "type": "list" } - ] + ], + "since": "3.0.0" }, { - "description": "Lists all hypervisor capabilities.", + "description": "Lists all network ACL items", "isasync": false, - "name": "listHypervisorCapabilities", + "name": "listNetworkACLs", "params": [ { - "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 traffic type - ingress or egress", "length": 255, - "name": "page", + "name": "traffictype", "required": false, - "type": "integer" + "type": "string" }, { - "description": "the hypervisor for which to restrict the search", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "hypervisor", + "name": "isrecursive", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "List by keyword", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "keyword", + "name": "domainid", + "related": "listDomainChildren,listDomains,listDomains", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "ID of the hypervisor capability", + "description": "list network ACL items by network ID", "length": 255, - "name": "id", - "related": "listHypervisorCapabilities", + "name": "networkid", + "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listSrxFirewallNetworks,listBrocadeVcsDeviceNetworks", "required": false, "type": "uuid" - } - ], - "related": "", - "response": [ - {}, - { - "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" + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller 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": "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 hypervisor version", - "name": "hypervisorversion", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "", + "length": 255, + "name": "page", + "required": false, "type": "integer" }, { - "description": "true if storage motion is supported", - "name": "storagemotionenabled", - "type": "boolean" - }, - { - "description": "the hypervisor type", - "name": "hypervisor", - "type": "hypervisortype" - }, - {}, - { - "description": "true if security group is supported", - "name": "securitygroupenabled", - "type": "boolean" + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "the ID of the hypervisor capabilities row", + "description": "Lists network ACL Item with the specified ID", + "length": 255, "name": "id", - "type": "string" - }, - { - "description": "true if VM snapshots are enabled for this hypervisor", - "name": "vmsnapshotenabled", - "type": "boolean" + "related": "createNetworkACL,listNetworkACLs,updateNetworkACLItem,moveNetworkAclItem", + "required": false, + "type": "uuid" }, { - "description": "the maximum number of Data Volumes that can be attached for this hypervisor", - "name": "maxdatavolumeslimit", - "type": "integer" - } - ], - "since": "3.0.0" - }, - { - "description": "Adds backup image store.", - "isasync": false, - "name": "addImageStore", - "params": [ - { - "description": "the URL for the image store", - "length": 2048, - "name": "url", + "description": "List resources by tags (key/value pairs)", + "length": 255, + "name": "tags", "required": false, - "type": "string" + "type": "map" }, { - "description": "the image store provider name", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "provider", - "required": true, + "name": "account", + "required": false, "type": "string" }, { - "description": "the name for the image store", + "description": "list network ACL items by ACL ID", "length": 255, - "name": "name", + "name": "aclid", + "related": "createNetworkACLList,listNetworkACLLists", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "the Zone ID for the image store", + "description": "list network ACL items by action", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "action", "required": false, - "type": "uuid" + "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", + "description": "list network ACL items by protocol", "length": 255, - "name": "details", + "name": "protocol", "required": false, - "type": "map" + "type": "string" } ], - "related": "addSecondaryStorage,listSwifts,addImageStoreS3,listImageStores,updateCloudToUseObjectStore", + "related": "createNetworkACL,updateNetworkACLItem,moveNetworkAclItem", "response": [ { - "description": "defines if store is read-only", - "name": "readonly", - "type": "boolean" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "type of the icmp message being sent", + "name": "icmptype", + "type": "integer" }, { - "description": "the url of the image store", - "name": "url", + "description": "Action of ACL Item. Allow/Deny", + "name": "action", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the list of resource tags associated with the network ACLs", + "name": "tags", + "response": [ + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + } + ], + "type": "list" }, { - "description": "the provider name of the image store", - "name": "providername", + "description": "the traffic type for the ACL", + "name": "traffictype", "type": "string" }, { - "description": "the protocol of the image store", + "description": "the protocol of the ACL", "name": "protocol", "type": "string" }, - {}, { - "description": "the Zone name of the image store", - "name": "zonename", + "description": "the ending port of ACL's port range", + "name": "endport", "type": "string" }, { - "description": "the Zone ID of the image store", - "name": "zoneid", + "description": "the ID of the ACL Item", + "name": "id", "type": "string" }, { - "description": "the host's currently used disk size", - "name": "disksizeused", - "type": "long" + "description": "the ID of the ACL this item belongs to", + "name": "aclid", + "type": "string" }, { - "description": "the scope of the image store", - "name": "scope", - "type": "scopetype" + "description": "is rule for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, + {}, { - "description": "the name of the image store", - "name": "name", + "description": "the starting port of ACL's port range", + "name": "startport", "type": "string" }, - {}, { - "description": "the ID of the image store", - "name": "id", + "description": "an explanation on why this ACL rule is being applied", + "name": "reason", "type": "string" }, { - "description": "the total disk size of the host", - "name": "disksizetotal", - "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 name of the ACL this item belongs to", + "name": "aclname", + "type": "string" }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" - } - ], - "since": "4.2.0" - }, - { - "description": "Revoke a certificate alias from a KVM host", - "isasync": false, - "name": "revokeTemplateDirectDownloadCertificate", - "params": [ + }, { - "description": "hypervisor type", - "length": 255, - "name": "hypervisor", - "required": true, + "description": "the state of the rule", + "name": "state", "type": "string" }, { - "description": "zone to revoke certificate", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": true, - "type": "uuid" + "description": "Number of the ACL Item", + "name": "number", + "type": "integer" }, { - "description": "(optional) the host ID to revoke certificate", - "length": 255, - "name": "hostid", - "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost,addBaremetalHost", - "required": false, - "type": "uuid" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, + { + "description": "error code for this icmp message", + "name": "icmpcode", + "type": "integer" + } + ] + }, + { + "description": "Delete site to site vpn gateway", + "isasync": true, + "name": "deleteVpnGateway", + "params": [ { - "description": "alias of the SSL certificate", + "description": "id of customer gateway", "length": 255, - "name": "name", + "name": "id", + "related": "createVpnGateway,listVpnGateways,updateVpnGateway", "required": true, - "type": "string" + "type": "uuid" } ], "response": [ + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, + {}, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" }, - {}, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "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" } - ], - "since": "4.13" + ] }, { - "description": "Syncs capabilities of storage pools", + "description": "Creates a service offering.", "isasync": false, - "name": "updateStorageCapabilities", + "name": "createServiceOffering", "params": [ { - "description": "Storage pool id", + "description": "Name of the storage policy defined at vCenter, this is applicable only for VMware", "length": 255, - "name": "id", - "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities", - "required": true, + "name": "storagepolicy", + "related": "listVsphereStoragePolicies", + "required": false, + "since": "4.15", "type": "uuid" - } - ], - "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool", - "response": [ + }, { - "description": "the Zone name of the storage pool", - "name": "zonename", + "description": "burst bytes write rate of the disk offering", + "length": 255, + "name": "byteswriteratemax", + "required": false, + "type": "long" + }, + { + "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": "burst io requests write rate of the disk offering", + "length": 255, + "name": "iopswriteratemax", + "required": false, + "type": "long" + }, + { + "description": "restrict the CPU usage to committed service offering", + "length": 255, + "name": "limitcpuuse", + "required": false, + "type": "boolean" + }, + { + "description": "bytes write rate of the disk offering", + "length": 255, + "name": "byteswriterate", + "required": false, + "type": "long" + }, + { + "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": "bytes read rate of the disk offering", + "length": 255, + "name": "bytesreadrate", + "required": false, + "type": "long" + }, + { + "description": "the name of the service offering", + "length": 255, + "name": "name", + "required": true, "type": "string" }, { - "description": "the storage pool capabilities", - "name": "storagecapabilities", - "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 maximum memory size of the custom service offering in MB", + "length": 255, + "name": "maxmemory", + "required": false, + "since": "4.13", + "type": "integer" + }, + { + "description": "the Root disk size in GB.", + "length": 255, + "name": "rootdisksize", + "required": false, + "since": "4.15", + "type": "long" + }, + { + "description": "the HA for the service offering", + "length": 255, + "name": "offerha", + "required": false, + "type": "boolean" }, { - "description": "IOPS CloudStack can provision from this storage pool", - "name": "capacityiops", - "type": "long" + "description": "the total memory of the service offering in MB", + "length": 255, + "name": "memory", + "required": false, + "type": "integer" }, { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", - "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": "the overprovisionfactor for the storage pool", - "name": "overprovisionfactor", + "description": "the system VM type. Possible types are \"domainrouter\", \"consoleproxy\" and \"secondarystoragevm\".", + "length": 255, + "name": "systemvmtype", + "required": false, "type": "string" }, - {}, { - "description": "the hypervisor type of the storage pool", - "name": "hypervisor", - "type": "string" + "description": "length (in seconds) of the burst", + "length": 255, + "name": "iopswriteratemaxlength", + "required": false, + "type": "long" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "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 Zone ID of the storage pool", - "name": "zoneid", + "description": "provisioning type used to create volumes. Valid values are thin, sparse, fat.", + "length": 255, + "name": "provisioningtype", + "required": false, "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "io requests write rate of the disk offering", + "length": 255, + "name": "iopswriterate", + "required": false, + "type": "long" }, { - "description": "the tags for the storage pool", - "name": "tags", - "type": "string" + "description": "data transfer rate in megabits per second allowed. Supported only for non-System offering and system offerings having \"domainrouter\" systemvmtype", + "length": 255, + "name": "networkrate", + "required": false, + "type": "integer" }, { - "description": "the IP address of the storage pool", - "name": "ipaddress", - "type": "string" + "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": "total min IOPS currently in use by volumes", - "name": "allocatediops", + "description": "length (in seconds) of the burst", + "length": 255, + "name": "bytesreadratemaxlength", + "required": false, "type": "long" }, { - "description": "the storage pool type", - "name": "type", + "description": "the host tag for this service offering.", + "length": 255, + "name": "hosttags", + "required": false, "type": "string" }, - {}, { - "description": "the name of the cluster for the storage pool", - "name": "clustername", - "type": "string" + "description": "length (in seconds) of the burst", + "length": 255, + "name": "iopsreadratemaxlength", + "required": false, + "type": "long" }, { - "description": "the scope of the storage pool", - "name": "scope", - "type": "string" + "description": "burst bytes read rate of the disk offering", + "length": 255, + "name": "bytesreadratemax", + "required": false, + "type": "long" }, { - "description": "the storage pool path", - "name": "path", + "description": "the display text of the service offering", + "length": 255, + "name": "displaytext", + "required": true, "type": "string" }, { - "description": "true if this pool is suitable to migrate a volume, false otherwise", - "name": "suitableformigration", + "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 date and time the storage pool was created", - "name": "created", - "type": "date" - }, - { - "description": "the state of the storage pool", - "name": "state", - "type": "storagepoolstatus" + "description": "The minimum memory size of the custom service offering in MB", + "length": 255, + "name": "minmemory", + "required": false, + "since": "4.13", + "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the tags for this service offering.", + "length": 255, + "name": "tags", + "required": false, "type": "string" }, { - "description": "the ID of the cluster for the storage pool", - "name": "clusterid", - "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 ID of the storage pool", - "name": "id", - "type": "string" + "description": "Whether service offering size is custom or not", + "length": 255, + "name": "customized", + "required": false, + "since": "4.13", + "type": "boolean" }, { - "description": "the Pod ID of the storage pool", - "name": "podid", - "type": "string" + "description": "the CPU number of the service offering", + "length": 255, + "name": "cpunumber", + "required": false, + "type": "integer" }, { - "description": "Storage provider for this pool", - "name": "provider", - "type": "string" + "description": "burst requests read rate of the disk offering", + "length": 255, + "name": "iopsreadratemax", + "required": false, + "type": "long" }, { - "description": "the total disk size of the storage pool", - "name": "disksizetotal", + "description": "max iops of the compute offering", + "length": 255, + "name": "maxiops", + "required": false, + "since": "4.4", "type": "long" }, { - "description": "the name of the storage pool", - "name": "name", - "type": "string" + "description": "min iops of the compute offering", + "length": 255, + "name": "miniops", + "required": false, + "since": "4.4", + "type": "long" }, { - "description": "the Pod name of the storage pool", - "name": "podname", - "type": "string" + "description": "is this a system vm offering", + "length": 255, + "name": "issystem", + "required": false, + "type": "boolean" }, { - "description": "the host's currently used disk size", - "name": "disksizeused", + "description": "length (in seconds) of the burst", + "length": 255, + "name": "byteswriteratemaxlength", + "required": false, "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", + "description": "io requests read rate of the disk offering", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", - "required": true, - "type": "uuid" + "name": "iopsreadrate", + "required": false, + "type": "long" }, { - "description": "ID of the project role to be deleted", + "description": "the CPU speed of the service offering in MHz.", "length": 255, - "name": "id", - "related": "createProjectRole,listProjectRoles,updateProjectRole", - "required": true, - "type": "uuid" - } - ], - "response": [ + "name": "cpuspeed", + "required": false, + "type": "integer" + }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The deployment planner heuristics used to deploy a VM of this offering. If null, value of global config vm.deployment.planner is used", + "length": 255, + "name": "deploymentplanner", + "required": false, "type": "string" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "details for planner, used to store specific parameters", + "length": 255, + "name": "serviceofferingdetails", + "required": false, + "type": "map" + }, + { + "description": "the storage type of the service offering. Values are local and shared.", + "length": 255, + "name": "storagetype", + "required": false, "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "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": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - } - ], - "since": "4.15.0" - }, - { - "description": "Get SolidFire Account ID", - "isasync": false, - "name": "getSolidFireAccountId", - "params": [ { - "description": "CloudStack Account UUID", + "description": "the cache mode to use for this disk offering. none, writeback or writethrough", "length": 255, - "name": "accountid", - "required": true, + "name": "cachemode", + "required": false, + "since": "4.14", "type": "string" }, { - "description": "Storage Pool UUID", + "description": "whether compute offering iops is custom or not", "length": 255, - "name": "storageid", - "required": true, - "type": "string" + "name": "customizediops", + "required": false, + "since": "4.4", + "type": "boolean" } ], - "related": "", + "related": "updateServiceOffering,listServiceOfferings", "response": [ - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "length (in seconds) of the burst", + "name": "diskIopsWriteRateMaxLength", + "type": "long" }, + {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "burst io requests write rate of the disk offering", + "name": "diskIopsWriteRateMax", + "type": "long" }, - {}, { - "description": "SolidFire Account ID", - "name": "solidFireAccountId", + "description": "io requests read rate of the service offering", + "name": "diskIopsReadRate", "type": "long" - } - ] - }, - { - "description": "Lists role permissions", - "isasync": false, - "name": "listRolePermissions", - "params": [ + }, { - "description": "ID of the role", - "length": 255, - "name": "roleid", - "related": "createRole,importRole,listRoles,updateRole", - "required": false, - "type": "uuid" - } - ], - "related": "", - "response": [ + "description": "the ha support in the service offering", + "name": "offerha", + "type": "boolean" + }, { - "description": "the ID of the role permission", - "name": "id", - "type": "string" + "description": "length (in second) of the burst", + "name": "diskIopsReadRateMaxLength", + "type": "long" }, - {}, { - "description": "the ID of the role to which the role permission belongs", - "name": "roleid", + "description": "the host tag for the service offering", + "name": "hosttags", "type": "string" }, { - "description": "the name of the role to which the role permission belongs", - "name": "rolename", + "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": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the api name or wildcard rule", - "name": "rule", - "type": "string" + "description": "the date this service offering was created", + "name": "created", + "type": "date" }, { - "description": "the permission type of the api name or wildcard rule, allow/deny", - "name": "permission", - "type": "string" + "description": "burst bytes read rate of the disk offering", + "name": "diskBytesReadRateMax", + "type": "long" }, { - "description": "the description of the role permission", - "name": "description", + "description": "the cache mode to use for this disk offering. none, writeback or writethrough", + "name": "cacheMode", "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - } - ], - "since": "4.9.0" - }, - { - "description": "Lists all network services provided by CloudStack or for the given Provider.", - "isasync": false, - "name": "listSupportedNetworkServices", - "params": [ + "description": "the min iops of the disk offering", + "name": "miniops", + "type": "long" + }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" + "description": "the storage type for this service offering", + "name": "storagetype", + "type": "string" }, { - "description": "network service provider name", - "length": 255, - "name": "provider", - "required": false, + "description": "provisioning type used to create volumes. Valid values are thin, sparse, fat.", + "name": "provisioningtype", "type": "string" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" + "description": "the max iops of the disk offering", + "name": "maxiops", + "type": "long" }, { - "description": "network service name to list providers and capabilities of", - "length": 255, - "name": "service", - "required": false, + "description": "bytes read rate of the service offering", + "name": "diskBytesReadRate", + "type": "long" + }, + { + "description": "is this a the systemvm type for system vm offering", + "name": "systemvmtype", "type": "string" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "domainid", "type": "string" - } - ], - "related": "", - "response": [ + }, { - "description": "the service provider name", - "name": "provider", - "response": [ - { - "description": "the provider name", - "name": "name", - "type": "string" - }, - { - "description": "state of the network provider", - "name": "state", - "type": "string" - }, - { - "description": "services for this provider", - "name": "servicelist", - "type": "list" - }, - { - "description": "true if individual services can be enabled/disabled", - "name": "canenableindividualservice", - "type": "boolean" - }, - { - "description": "the destination physical network", - "name": "destinationphysicalnetworkid", - "type": "string" - }, - { - "description": "uuid of the network provider", - "name": "id", - "type": "string" - }, - { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", - "type": "string" - } - ], - "type": "list" + "description": "io requests write rate of the service offering", + "name": "diskIopsWriteRate", + "type": "long" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "length (in seconds) of the burst", + "name": "diskBytesWriteRateMaxLength", + "type": "long" + }, + { + "description": "the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "zone", "type": "string" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "the clock rate CPU speed in Mhz", + "name": "cpuspeed", "type": "integer" }, - {}, - { - "description": "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": "bytes write rate of the service offering", + "name": "diskBytesWriteRate", + "type": "long" }, { - "description": "the service name", - "name": "name", + "description": "the ID of the disk offering to which service offering is linked", + "name": "diskofferingid", "type": "string" - } - ], - "since": "3.0.0" - }, - { - "description": "Deletes a particular ingress rule from this security group", - "isasync": true, - "name": "revokeSecurityGroupIngress", - "params": [ + }, { - "description": "The ID of the ingress rule", - "length": 255, - "name": "id", - "related": "authorizeSecurityGroupIngress", - "required": true, - "type": "uuid" - } - ], - "response": [ - {}, + "description": "burst bytes write rate of the disk offering", + "name": "diskBytesWriteRateMax", + "type": "long" + }, { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" + "description": "is true if the offering is customized", + "name": "iscustomized", + "type": "boolean" }, { - "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" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the name of the service offering", + "name": "name", "type": "string" }, {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - } - ] - }, - { - "description": "Lists dedicated guest vlan ranges", - "isasync": false, - "name": "listDedicatedGuestVlanRanges", - "params": [ + "description": "additional key/value details tied with this service offering", + "name": "serviceofferingdetails", + "type": "map" + }, { - "description": "list dedicated guest vlan ranges by id", - "length": 255, - "name": "id", - "related": "listDedicatedGuestVlanRanges", - "required": false, - "type": "uuid" + "description": "an alternate display text of the service offering.", + "name": "displaytext", + "type": "string" }, { - "description": "the account with which the guest VLAN range is associated. Must be used with the domainId parameter.", - "length": 255, - "name": "account", - "required": false, + "description": "name of the disk offering", + "name": "diskofferingname", "type": "string" }, { - "description": "zone of the guest VLAN range", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": false, - "type": "uuid" + "description": "the id of the service offering", + "name": "id", + "type": "string" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, + "description": "the vsphere storage policy tagged to the service offering in case of VMware", + "name": "vspherestoragepolicy", + "type": "string" + }, + { + "description": "the number of CPU", + "name": "cpunumber", "type": "integer" }, { - "description": "project who will own the guest VLAN range", - "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", - "required": false, - "type": "uuid" + "description": "restrict the CPU usage to committed service offering", + "name": "limitcpuuse", + "type": "boolean" }, { - "description": "physical network id of the guest VLAN range", - "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork", - "required": false, - "type": "uuid" + "description": "true if virtual machine needs to be dynamically scalable of cpu or memory", + "name": "dynamicscalingenabled", + "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.", - "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains,listDomains", - "required": false, - "type": "uuid" + "description": "burst io requests read rate of the disk offering", + "name": "diskIopsReadRateMax", + "type": "long" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" + "description": "data transfer rate in megabits per second allowed.", + "name": "networkrate", + "type": "integer" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, + "description": "the memory in MB", + "name": "memory", "type": "integer" }, { - "description": "the dedicated guest vlan range", - "length": 255, - "name": "guestvlanrange", - "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" - } - ], - "related": "", - "response": [ + }, { - "description": "the account of the guest VLAN range", - "name": "account", - "type": "string" + "description": "True/False to indicate the strictness of the disk offering association with the compute offering. When set to true, override of disk offering is not allowed when VM is deployed and change disk offering is not allowed for the ROOT disk after the VM is deployed", + "name": "diskofferingstrictness", + "type": "boolean" + }, + { + "description": "true if disk offering uses custom iops, false otherwise", + "name": "iscustomizediops", + "type": "boolean" + }, + { + "description": "Root disk size in GB", + "name": "rootdisksize", + "type": "long" }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - {}, + { + "description": "the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "domain", + "type": "string" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the physical network of the guest vlan range", - "name": "physicalnetworkid", + "description": "length (in seconds) of the burst", + "name": "diskBytesReadRateMaxLength", "type": "long" }, { - "description": "the guest VLAN range", - "name": "guestvlanrange", - "type": "string" - }, - { - "description": "the domain ID of the guest VLAN range", - "name": "domainid", - "type": "string" - }, - { - "description": "the project id of the guest vlan range", - "name": "projectid", - "type": "string" + "description": "is this a default system vm offering", + "name": "defaultuse", + "type": "boolean" }, { - "description": "the ID of the guest VLAN range", - "name": "id", + "description": "deployment strategy used to deploy VM.", + "name": "deploymentplanner", "type": "string" }, - {}, { - "description": "the domain name of the guest VLAN range", - "name": "domain", + "description": "the display text of the disk offering", + "name": "diskofferingdisplaytext", "type": "string" }, { - "description": "the project name of the guest vlan range", - "name": "project", - "type": "string" + "description": "Hypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware)", + "name": "hypervisorsnapshotreserve", + "type": "integer" }, { - "description": "the zone of the guest vlan range", - "name": "zoneid", - "type": "long" + "description": "is this a system vm offering", + "name": "issystem", + "type": "boolean" } ] }, { - "description": "Adds a network serviceProvider to a physical network", + "description": "Copies a template from one zone to another.", "isasync": true, - "name": "addNetworkServiceProvider", + "name": "copyTemplate", "params": [ { - "description": "the list of services to be enabled for this physical network service provider", + "description": "ID of the zone the template is being copied to.", "length": 255, - "name": "servicelist", + "name": "destzoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, - "type": "list" + "type": "uuid" }, { - "description": "the destination Physical Network ID to bridge to", + "description": "Template ID.", "length": 255, - "name": "destinationphysicalnetworkid", - "related": "createPhysicalNetwork", - "required": false, + "name": "id", + "related": "listIsos,registerIso,copyTemplate,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", + "required": true, "type": "uuid" }, { - "description": "the Physical Network ID to add the provider to", + "description": "ID of the zone the template is currently hosted on. If not specified and template is cross-zone, then we will sync this template to region wide image store.", "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork", - "required": true, + "name": "sourcezoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": false, "type": "uuid" }, { - "description": "the name for the physical network service provider", + "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": "name", - "required": true, - "type": "string" + "name": "destzoneids", + "related": "createZone,updateZone,listZones,listZones", + "required": false, + "type": "list" } ], - "related": "listNetworkServiceProviders,listTrafficTypes", + "related": "listIsos,registerIso,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", "response": [ { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", + "description": "the ID of the zone for this template", + "name": "zoneid", "type": "string" }, { - "description": "services for this provider", - "name": "servicelist", - "type": "list" + "description": "the project name of the template", + "name": "project", + "type": "string" }, { - "description": "true if individual services can be enabled/disabled", - "name": "canenableindividualservice", - "type": "boolean" + "description": "the physical size of the template", + "name": "physicalsize", + "type": "long" }, - {}, { - "description": "uuid of the network provider", - "name": "id", + "description": "the ID of the domain to which the template belongs", + "name": "domainid", "type": "string" }, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the template name", + "name": "name", "type": "string" }, { - "description": "the destination physical network", - "name": "destinationphysicalnetworkid", - "type": "string" + "description": "true if the template is extractable, false otherwise", + "name": "isextractable", + "type": "boolean" }, { - "description": "state of the network provider", - "name": "state", - "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 provider name", - "name": "name", + "description": "the tag of this template", + "name": "templatetag", "type": "string" - } - ], - "since": "3.0.0" - }, - { - "description": "Lists all network ACL items", - "isasync": false, - "name": "listNetworkACLs", - "params": [ + }, { - "description": "list network ACL items by ACL ID", - "length": 255, - "name": "aclid", - "related": "createNetworkACLList,listNetworkACLLists", - "required": false, - "type": "uuid" + "description": "the status of the template", + "name": "status", + "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": "the template ID", + "name": "id", + "type": "string" + }, + { + "description": "the date this template was removed", + "name": "removed", + "type": "date" + }, + { + "description": "the processor bit size", + "name": "bits", + "type": "int" + }, + { + "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", + "name": "isdynamicallyscalable", "type": "boolean" }, { - "description": "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 this template is a featured template, false otherwise", + "name": "isfeatured", "type": "boolean" }, { - "description": "list resources by account. Must be used with the domainId parameter.", - "length": 255, - "name": "account", - "required": false, - "type": "string" + "description": "the size of the template", + "name": "size", + "type": "long" }, + {}, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "list network ACL items by action", - "length": 255, - "name": "action", - "required": false, - "type": "string" + "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", + "name": "directdownload", + "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 network ACL items by network ID", - "length": 255, - "name": "networkid", - "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listF5LoadBalancerNetworks,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listSrxFirewallNetworks,listBrocadeVcsDeviceNetworks", - "required": false, - "type": "uuid" + "description": "the format of the template.", + "name": "format", + "type": "imageformat" }, { - "description": "List resources by tags (key/value pairs)", - "length": 255, - "name": "tags", - "required": false, + "description": "the name of the zone for this template", + "name": "zonename", + "type": "string" + }, + { + "description": "VMware only: additional key/value details tied with deploy-as-is template", + "name": "deployasisdetails", "type": "map" }, { - "description": "list only resources belonging to the domain specified", - "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains,listDomains", - "required": false, - "type": "uuid" + "description": "true if the template is ready to be deployed from, false otherwise.", + "name": "isready", + "type": "boolean" }, { - "description": "list objects by project", - "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", - "required": false, - "type": "uuid" + "description": "the date this template was created", + "name": "created", + "type": "date" }, { - "description": "list network ACL items by traffic type - ingress or egress", - "length": 255, - "name": "traffictype", - "required": false, + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" + "description": "true if the reset password feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" }, { - "description": "list network ACL items by protocol", - "length": 255, - "name": "protocol", - "required": false, + "description": "the template display text", + "name": "displaytext", "type": "string" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false", - "length": 255, - "name": "listall", - "required": false, - "type": "boolean" + "description": "the type of the template", + "name": "templatetype", + "type": "string" }, { - "description": "Lists network ACL Item with the specified ID", - "length": 255, - "name": "id", - "related": "createNetworkACL,listNetworkACLs,updateNetworkACLItem,moveNetworkAclItem", - "required": false, - "type": "uuid" - } - ], - "related": "createNetworkACL,updateNetworkACLItem,moveNetworkAclItem", - "response": [ + "description": "VMware only: true if template is deployed without orchestrating disks and networks but \"as-is\" defined in the template.", + "name": "deployasis", + "type": "boolean" + }, { - "description": "type of the icmp message being sent", - "name": "icmptype", - "type": "integer" + "description": "true if the template is managed across all Zones, false otherwise", + "name": "crossZones", + "type": "boolean" }, { - "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", + "description": "if Datadisk template, then id of the root disk template this template belongs to", + "name": "parenttemplateid", "type": "string" }, { - "description": "error code for this icmp message", - "name": "icmpcode", - "type": "integer" + "description": "the name of the domain to which the template belongs", + "name": "domain", + "type": "string" }, { - "description": "the starting port of ACL's port range", - "name": "startport", - "type": "string" + "description": "true if template is sshkey enabled, false otherwise", + "name": "sshkeyenabled", + "type": "boolean" }, { - "description": "Action of ACL Item. Allow/Deny", - "name": "action", + "description": "the template ID of the parent template if present", + "name": "sourcetemplateid", "type": "string" }, { - "description": "the state of the rule", - "name": "state", + "description": "the ID of the OS type for this template.", + "name": "ostypeid", "type": "string" }, { - "description": "is rule for display to the regular user", - "name": "fordisplay", + "description": "true if template requires HVM enabled, false otherwise", + "name": "requireshvm", "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the account id to which the template belongs", + "name": "accountid", "type": "string" }, { - "description": "the ID of the ACL this item belongs to", - "name": "aclid", + "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 name of the OS type for this template.", + "name": "ostypename", + "type": "string" }, { - "description": "the list of resource tags associated with the network ACLs", - "name": "tags", - "response": [ - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, + "description": "additional key/value details tied with template", + "name": "details", + "type": "map" + }, + { + "description": "the list of resource tags associated", + "name": "tags", + "response": [ { - "description": "id of the resource", - "name": "resourceid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { @@ -42394,11 +43953,6 @@ "name": "value", "type": "string" }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, { "description": "resource type", "name": "resourcetype", @@ -42415,8 +43969,13 @@ "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { @@ -42425,925 +43984,806 @@ "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" } ], - "type": "list" - }, - { - "description": "Number of the ACL Item", - "name": "number", - "type": "integer" + "type": "set" }, { - "description": "the traffic type for the ACL", - "name": "traffictype", + "description": "the URL which the template/iso is registered from", + "name": "url", "type": "string" }, { - "description": "an explanation on why this ACL rule is being applied", - "name": "reason", + "description": "the account name to which the template belongs", + "name": "account", "type": "string" }, { - "description": "the ending port of ACL's port range", - "name": "endport", - "type": "string" + "description": "true if this template is a public template, false otherwise", + "name": "ispublic", + "type": "boolean" }, { - "description": "the name of the ACL this item belongs to", - "name": "aclname", + "description": "the project id of the template", + "name": "projectid", "type": "string" }, - {}, - {}, { - "description": "the protocol of the ACL", - "name": "protocol", + "description": "checksum of the template", + "name": "checksum", "type": "string" }, { - "description": "the ID of the ACL Item", - "name": "id", + "description": "the ID of the secondary storage host for the template", + "name": "hostid", "type": "string" - } - ] - }, - { - "description": "Delete site to site vpn gateway", - "isasync": true, - "name": "deleteVpnGateway", - "params": [ - { - "description": "id of customer gateway", - "length": 255, - "name": "id", - "related": "createVpnGateway,listVpnGateways,updateVpnGateway", - "required": true, - "type": "uuid" - } - ], - "response": [ - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - {}, - { - "description": "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 the download progress of a template across all secondary storages", + "name": "downloaddetails", + "type": "list" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "if root disk template, then ids of the datas disk templates this template owns", + "name": "childtemplates", + "type": "set" } ] }, { - "description": "Creates a service offering.", + "description": "lists network that are using a nicira nvp device", "isasync": false, - "name": "createServiceOffering", + "name": "listNiciraNvpDeviceNetworks", "params": [ { - "description": "io requests read rate of the disk offering", - "length": 255, - "name": "iopsreadrate", - "required": false, - "type": "long" - }, - { - "description": "the CPU number of the service offering", - "length": 255, - "name": "cpunumber", - "required": false, - "type": "integer" - }, - { - "description": "The minimum memroy size of the custom service offering in MB", - "length": 255, - "name": "minmemory", - "required": false, - "since": "4.13", - "type": "integer" - }, - { - "description": "the system VM type. Possible types are \"domainrouter\", \"consoleproxy\" and \"secondarystoragevm\".", - "length": 255, - "name": "systemvmtype", - "required": false, - "type": "string" - }, - { - "description": "Name of the storage policy defined at vCenter, this is applicable only for VMware", + "description": "nicira nvp device ID", "length": 255, - "name": "storagepolicy", - "related": "listVsphereStoragePolicies", - "required": false, - "since": "4.15", + "name": "nvpdeviceid", + "related": "addNiciraNvpDevice,listNiciraNvpDevices", + "required": true, "type": "uuid" }, { - "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 total memory of the service offering in MB", - "length": 255, - "name": "memory", - "required": false, - "type": "integer" - }, - { - "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 deployment planner heuristics used to deploy a VM of this offering. If null, value of global config vm.deployment.planner is used", + "description": "List by keyword", "length": 255, - "name": "deploymentplanner", + "name": "keyword", "required": false, "type": "string" }, { - "description": "Hypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware)", + "description": "", "length": 255, - "name": "hypervisorsnapshotreserve", + "name": "page", "required": false, - "since": "4.4", "type": "integer" }, { - "description": "burst requests read rate of the disk offering", - "length": 255, - "name": "iopsreadratemax", - "required": false, - "type": "long" - }, - { - "description": "data transfer rate in megabits per second allowed. Supported only for non-System offering and system offerings having \"domainrouter\" systemvmtype", + "description": "", "length": 255, - "name": "networkrate", + "name": "pagesize", "required": false, "type": "integer" - }, - { - "description": "bytes write rate of the disk offering", - "length": 255, - "name": "byteswriterate", - "required": false, - "type": "long" - }, - { - "description": "the ID of the containing domain(s), null for public offerings", - "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains,listDomains", - "required": false, - "type": "list" - }, + } + ], + "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listPaloAltoFirewallNetworks,listSrxFirewallNetworks,listBrocadeVcsDeviceNetworks", + "response": [ { - "description": "length (in seconds) of the burst", - "length": 255, - "name": "iopswriteratemaxlength", - "required": false, - "type": "long" + "description": "zone id of the network", + "name": "zoneid", + "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": "true if network can span multiple zones", + "name": "strechedl2subnet", + "type": "boolean" }, { - "description": "burst bytes write rate of the disk offering", - "length": 255, - "name": "byteswriteratemax", - "required": false, - "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": "min iops of the compute offering", - "length": 255, - "name": "miniops", - "required": false, - "since": "4.4", - "type": "long" + "description": "Name of the VPC to which this network belongs", + "name": "vpcname", + "type": "string" }, { - "description": "io requests write rate of the disk offering", - "length": 255, - "name": "iopswriterate", - "required": false, - "type": "long" + "description": "state of the network", + "name": "state", + "type": "string" }, { - "description": "details for planner, used to store specific parameters", - "length": 255, - "name": "serviceofferingdetails", - "required": false, - "type": "map" + "description": "true if network offering is ip conserve mode enabled", + "name": "networkofferingconservemode", + "type": "boolean" }, { - "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 date this network was created", + "name": "created", + "type": "date" }, { - "description": "the tags for this service offering.", - "length": 255, - "name": "tags", - "required": false, + "description": "the name of the Network associated with this private gateway", + "name": "associatednetwork", "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": "display text of the network offering the network is created from", + "name": "networkofferingdisplaytext", "type": "string" }, + {}, { - "description": "length (in seconds) of the burst", - "length": 255, - "name": "byteswriteratemaxlength", - "required": false, - "type": "long" - }, - { - "description": "bytes read rate of the disk offering", - "length": 255, - "name": "bytesreadrate", - "required": false, - "type": "long" + "description": "the name of the Network associated with this network", + "name": "associatednetwork", + "type": "string" }, { - "description": "the HA for the service offering", - "length": 255, - "name": "offerha", - "required": false, + "description": "true network requires restart", + "name": "restartrequired", "type": "boolean" }, { - "description": "length (in seconds) of the burst", - "length": 255, - "name": "bytesreadratemaxlength", - "required": false, - "type": "long" - }, - { - "description": "the host tag for this service offering.", - "length": 255, - "name": "hosttags", - "required": false, + "description": "the ID of the Network associated with this private gateway", + "name": "associatednetworkid", "type": "string" }, { - "description": "restrict the CPU usage to committed service offering", - "length": 255, - "name": "limitcpuuse", - "required": false, - "type": "boolean" + "description": "the list of resource tags associated with network", + "name": "tags", + "response": [ + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + } + ], + "type": "list" }, { - "description": "Whether service offering size is custom or not", - "length": 255, - "name": "customized", - "required": false, - "since": "4.13", - "type": "boolean" + "description": "the physical network id", + "name": "physicalnetworkid", + "type": "string" }, { - "description": "burst io requests write rate of the disk offering", - "length": 255, - "name": "iopswriteratemax", - "required": false, - "type": "long" + "description": "The internet protocol of network offering", + "name": "internetprotocol", + "type": "string" }, { - "description": "length (in seconds) of the burst", - "length": 255, - "name": "iopsreadratemaxlength", - "required": false, + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", "type": "long" }, { - "description": "The maximum memroy size of the custom service offering in MB", - "length": 255, - "name": "maxmemory", - "required": false, - "since": "4.13", - "type": "integer" - }, - { - "description": "the display text of the service offering", - "length": 255, - "name": "displaytext", - "required": true, + "description": "the name of the zone the network belongs to", + "name": "zonename", "type": "string" }, { - "description": "the CPU speed of the service offering in MHz.", - "length": 255, - "name": "cpuspeed", - "required": false, - "type": "integer" - }, - { - "description": "the name of the service offering", - "length": 255, + "description": "the name of the network", "name": "name", - "required": true, "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": "Broadcast domain type of the network", + "name": "broadcastdomaintype", + "type": "string" }, { - "description": "provisioning type used to create volumes. Valid values are thin, sparse, fat.", - "length": 255, - "name": "provisioningtype", - "required": false, + "description": "the first DNS for the network", + "name": "dns1", "type": "string" }, { - "description": "max iops of the compute offering", - "length": 255, - "name": "maxiops", - "required": false, - "since": "4.4", - "type": "long" + "description": "VPC the network belongs to", + "name": "vpcid", + "type": "string" }, { - "description": "whether compute offering iops is custom or not", - "length": 255, - "name": "customizediops", - "required": false, - "since": "4.4", - "type": "boolean" + "description": "The external id of the network", + "name": "externalid", + "type": "string" }, { - "description": "the Root disk size in GB.", - "length": 255, - "name": "rootdisksize", - "required": false, - "since": "4.15", - "type": "long" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "is this a system vm offering", - "length": 255, - "name": "issystem", - "required": false, + "description": "true if network supports specifying ip ranges, false otherwise", + "name": "specifyipranges", "type": "boolean" }, { - "description": "the storage type of the service offering. Values are local and shared.", - "length": 255, - "name": "storagetype", - "required": false, + "description": "the displaytext of the network", + "name": "displaytext", "type": "string" - } - ], - "related": "updateServiceOffering,listServiceOfferings", - "response": [ - { - "description": "Root disk size in GB", - "name": "rootdisksize", - "type": "long" - }, - { - "description": "io requests write rate of the service offering", - "name": "diskIopsWriteRate", - "type": "long" }, { - "description": "the vsphere storage policy tagged to the service offering in case of VMware", - "name": "vspherestoragepolicy", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "burst bytes write rate of the disk offering", - "name": "diskBytesWriteRateMax", - "type": "long" - }, - { - "description": "true if the vm needs to be volatile, i.e., on every reboot of vm from API root disk is discarded and creates a new root disk", - "name": "isvolatile", - "type": "boolean" - }, - { - "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zoneid", + "description": "related to what other network configuration", + "name": "related", "type": "string" }, { - "description": "the clock rate CPU speed in Mhz", - "name": "cpuspeed", - "type": "integer" + "description": "broadcast uri of the network. This parameter is visible to ROOT admins only", + "name": "broadcasturi", + "type": "string" }, { - "description": "true if virtual machine needs to be dynamically scalable of cpu or memory", - "name": "dynamicscalingenabled", - "type": "boolean" + "description": "The routes for the network to ease adding route in upstream router", + "name": "ip6routes", + "type": "set" }, { - "description": "the id of the service offering", - "name": "id", + "description": "the network's IP range not to be used by CloudStack guest VMs and can be used for non CloudStack purposes", + "name": "reservediprange", "type": "string" }, { - "description": "the host tag for the service offering", - "name": "hosttags", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "is true if the offering is customized", - "name": "iscustomized", - "type": "boolean" + "description": "ACL name associated with the VPC network", + "name": "aclname", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "availability of the network offering the network is created from", + "name": "networkofferingavailability", "type": "string" }, { - "description": "data transfer rate in megabits per second allowed.", - "name": "networkrate", - "type": "integer" + "description": "an optional field, whether to the display the network to the end user or not.", + "name": "displaynetwork", + "type": "boolean" }, { - "description": "the number of CPU", - "name": "cpunumber", - "type": "integer" + "description": "the owner of the network", + "name": "account", + "type": "string" }, + {}, { - "description": "length (in second) of the burst", - "name": "diskIopsReadRateMaxLength", - "type": "long" + "description": "true if guest network default egress policy is allow; false if default egress policy is deny", + "name": "egressdefaultpolicy", + "type": "boolean" }, { - "description": "the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "domainid", + "description": "the ID of the Network associated with this network", + "name": "associatednetworkid", "type": "string" }, { - "description": "bytes read rate of the service offering", - "name": "diskBytesReadRate", - "type": "long" + "description": "the domain name of the network owner", + "name": "domain", + "type": "string" }, { - "description": "the name of the service offering", - "name": "name", + "description": "The vlan of the network. This parameter is visible to ROOT admins only", + "name": "vlan", "type": "string" }, { - "description": "the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zone", + "description": "network offering id the network is created from", + "name": "networkofferingid", "type": "string" }, { - "description": "the storage type for this service offering", - "name": "storagetype", - "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 ha support in the service offering", - "name": "offerha", - "type": "boolean" + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" }, { - "description": "the date this service offering was created", - "name": "created", - "type": "date" + "description": "If the network has redundant routers enabled", + "name": "redundantrouter", + "type": "boolean" }, { - "description": "an alternate display text of the service offering.", - "name": "displaytext", + "description": "ACL Id associated with the VPC network", + "name": "aclid", "type": "string" }, { - "description": "true if disk offering uses custom iops, false otherwise", - "name": "iscustomizediops", + "description": "true if network is system, false otherwise", + "name": "issystem", "type": "boolean" }, { - "description": "deployment strategy used to deploy VM.", - "name": "deploymentplanner", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "provisioning type used to create volumes. Valid values are thin, sparse, fat.", - "name": "provisioningtype", + "description": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR", + "name": "cidr", "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 details of the network", + "name": "details", + "type": "map" }, { - "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 domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "domain", + "description": "the id of the network", + "name": "id", "type": "string" }, { - "description": "is this a default system vm offering", - "name": "defaultuse", + "description": "true if network is default, false otherwise", + "name": "isdefault", "type": "boolean" }, { - "description": "is this a system vm offering", - "name": "issystem", + "description": "list networks that are persistent", + "name": "ispersistent", "type": "boolean" }, { - "description": "is this a the systemvm type for system vm offering", - "name": "systemvmtype", - "type": "string" + "description": "true if users from subdomains can access the domain level network", + "name": "subdomainaccess", + "type": "boolean" }, { - "description": "the memory in MB", - "name": "memory", - "type": "integer" + "description": "list networks available for vm deployment", + "name": "canusefordeploy", + "type": "boolean" }, { - "description": "bytes write rate of the service offering", - "name": "diskBytesWriteRate", - "type": "long" + "description": "the domain id of the network owner", + "name": "domainid", + "type": "string" }, { - "description": "burst bytes read rate of the disk offering", - "name": "diskBytesReadRateMax", - "type": "long" + "description": "the network's gateway", + "name": "gateway", + "type": "string" }, { - "description": "restrict the CPU usage to committed service offering", - "name": "limitcpuuse", - "type": "boolean" + "description": "the project id of the ipaddress", + "name": "projectid", + "type": "string" }, - {}, { - "description": "io requests read rate of the service offering", - "name": "diskIopsReadRate", - "type": "long" + "description": "the list of services", + "name": "service", + "response": [ + { + "description": "the service provider name", + "name": "provider", + "response": [ + { + "description": "state of the network provider", + "name": "state", + "type": "string" + }, + { + "description": "uuid of the network provider", + "name": "id", + "type": "string" + }, + { + "description": "true if individual services can be enabled/disabled", + "name": "canenableindividualservice", + "type": "boolean" + }, + { + "description": "the provider name", + "name": "name", + "type": "string" + }, + { + "description": "the destination physical network", + "name": "destinationphysicalnetworkid", + "type": "string" + }, + { + "description": "the physical network this belongs to", + "name": "physicalnetworkid", + "type": "string" + }, + { + "description": "services for this provider", + "name": "servicelist", + "type": "list" + } + ], + "type": "list" + }, + { + "description": "the list of capabilities", + "name": "capability", + "response": [ + { + "description": "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" + } + ], + "type": "list" }, - {}, { - "description": "length (in seconds) of the burst", - "name": "diskIopsWriteRateMaxLength", - "type": "long" + "description": "the second DNS for the network", + "name": "dns2", + "type": "string" }, { - "description": "the max iops of the disk offering", - "name": "maxiops", - "type": "long" + "description": "name of the network offering the network is created from", + "name": "networkofferingname", + "type": "string" }, { - "description": "burst io requests write rate of the disk offering", - "name": "diskIopsWriteRateMax", - "type": "long" + "description": "the traffic type of the network", + "name": "traffictype", + "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "The routing mode of network offering", + "name": "ip6routing", + "type": "string" }, { - "description": "the tags for the service offering", - "name": "storagetags", + "description": "acl type - access type to the network", + "name": "acltype", "type": "string" }, { - "description": "the min iops of the disk offering", - "name": "miniops", + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", "type": "long" }, { - "description": "the cache mode to use for this disk offering. none, writeback or writethrough", - "name": "cacheMode", + "description": "the network's netmask", + "name": "netmask", "type": "string" }, { - "description": "length (in seconds) of the burst", - "name": "diskBytesReadRateMaxLength", - "type": "long" - }, - { - "description": "burst io requests read rate of the disk offering", - "name": "diskIopsReadRateMax", - "type": "long" + "description": "the type of the network", + "name": "type", + "type": "string" }, { - "description": "additional key/value details tied with this service offering", - "name": "serviceofferingdetails", - "type": "map" + "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 network domain", + "name": "networkdomain", + "type": "string" } ] }, { - "description": "Copies a template from one zone to another.", - "isasync": true, - "name": "copyTemplate", + "description": "Change ownership of a VM from one account to another. This API is available for Basic zones with security groups and Advanced zones with guest networks. A root administrator can reassign a VM from any account to any other account in any domain. A domain administrator can reassign a VM to any account in the same domain.", + "isasync": false, + "name": "assignVirtualMachine", "params": [ { - "description": "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": "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": "sourcezoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "securitygroupids", + "related": "createSecurityGroup", "required": false, - "type": "uuid" + "type": "list" }, { - "description": "Template ID.", + "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": "id", - "related": "listIsos,registerIso,copyTemplate,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", - "required": true, + "name": "networkids", + "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listPaloAltoFirewallNetworks,listSrxFirewallNetworks,listBrocadeVcsDeviceNetworks", + "required": false, + "type": "list" + }, + { + "description": "an optional project for the new VM owner.", + "length": 255, + "name": "projectid", + "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", + "required": false, "type": "uuid" }, { - "description": "A list of IDs of the zones that the template needs to be copied to.Specify this list if the template needs to copied to multiple zones in one go. Do not specify destzoneid and destzoneids together, however one of them is required.", + "description": "account name of the new VM owner.", "length": 255, - "name": "destzoneids", - "related": "createZone,updateZone,listZones,listZones", + "name": "account", "required": false, - "type": "list" + "type": "string" }, { - "description": "ID of the zone the template is being copied to.", + "description": "id of the VM to be moved", "length": 255, - "name": "destzoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "virtualmachineid", + "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance", + "required": true, + "type": "uuid" + }, + { + "description": "domain id of the new VM owner.", + "length": 255, + "name": "domainid", + "related": "listDomainChildren,listDomains,listDomains", "required": false, "type": "uuid" } ], - "related": "listIsos,registerIso,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", + "related": "migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance", "response": [ { - "description": "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": "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": "additional key/value details tied with template", - "name": "details", - "type": "map" - }, - { - "description": "the tag of this template", - "name": "templatetag", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "true if the reset password feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" - }, - { - "description": "true if the template is ready to be deployed from, false otherwise.", - "name": "isready", - "type": "boolean" + "description": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" }, { - "description": "the name of the OS type for this template.", - "name": "ostypename", + "description": "the user's ID who deployed the virtual machine", + "name": "userid", "type": "string" }, { - "description": "the ID of the secondary storage host for the template", - "name": "hostid", + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", "type": "string" }, { - "description": "true if the template is extractable, false otherwise", - "name": "isextractable", - "type": "boolean" - }, - { - "description": "if Datadisk template, then id of the root disk template this template belongs to", - "name": "parenttemplateid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "VMware only: additional key/value details tied with deploy-as-is template", - "name": "deployasisdetails", - "type": "map" - }, - { - "description": "the type of the template", - "name": "templatetype", - "type": "string" + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" }, - {}, - {}, { - "description": "the template display text", - "name": "displaytext", - "type": "string" + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" }, { - "description": "the name of the zone for this template", - "name": "zonename", - "type": "string" + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" }, { - "description": "the list of resource tags associated", - "name": "tags", + "description": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", "response": [ { - "description": "tag value", - "name": "value", + "description": "the ID of the affinity group", + "name": "id", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the name of the affinity group", + "name": "name", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the type of the affinity group", + "name": "type", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the project name of the affinity group", + "name": "project", "type": "string" }, { - "description": "the ID of the domain associated with the tag", + "description": "the domain ID of the affinity group", "name": "domainid", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the description of the affinity group", + "name": "description", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the project ID of the affinity group", + "name": "projectid", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", - "type": "string" + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" }, { - "description": "the account associated with the tag", + "description": "the account owning the affinity group", "name": "account", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the domain name of the affinity group", + "name": "domain", "type": "string" } ], "type": "set" }, + {}, { - "description": "the project id of the template", - "name": "projectid", - "type": "string" - }, - { - "description": "the size of the template", - "name": "size", - "type": "long" - }, - { - "description": "the ID of the domain to which the template belongs", + "description": "the ID of the domain in which the virtual machine exists", "name": "domainid", "type": "string" }, { - "description": "the ID of the zone for this template", - "name": "zoneid", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "Vm details in key/value pairs.", + "name": "details", + "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 name of the template for the virtual machine", + "name": "templatename", + "type": "string" }, { - "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", - "name": "directdownload", - "type": "boolean" + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" }, { - "description": "the date this template was created", - "name": "created", - "type": "date" + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" }, { - "description": "the name of the secondary storage host for the template", - "name": "hostname", + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", "type": "string" }, { - "description": "the processor bit size", - "name": "bits", - "type": "int" + "description": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" }, { - "description": "the ID of the OS type for this template.", - "name": "ostypeid", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { - "description": "the date this template was removed", - "name": "removed", - "type": "date" + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", + "type": "string" }, { - "description": "the URL which the template/iso is registered from", - "name": "url", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, { - "description": "the project name of the template", - "name": "project", + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" + }, + { + "description": "ssh key-pairs", + "name": "keypairs", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", - "type": "string" + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" }, + {}, { - "description": "true if the ISO is bootable, false otherwise", - "name": "bootable", - "type": "boolean" + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" }, { - "description": "the account name to which the template belongs", - "name": "account", + "description": "Guest vm Boot Mode", + "name": "bootmode", "type": "string" }, { - "description": "the status of the template", - "name": "status", + "description": "device type of the root volume", + "name": "rootdevicetype", "type": "string" }, { @@ -43352,882 +44792,1041 @@ "type": "resourceiconresponse" }, { - "description": "true if the template is managed across all Zones, false otherwise", - "name": "crossZones", - "type": "boolean" + "description": "the read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" }, { - "description": "true if this template is a featured template, false otherwise", - "name": "isfeatured", + "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 format of the template.", - "name": "format", - "type": "imageformat" - }, - { - "description": "the template ID", - "name": "id", - "type": "string" + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" }, { - "description": "the account id to which the template belongs", - "name": "accountid", + "description": "the ID of the availablility zone for the virtual machine", + "name": "zoneid", "type": "string" }, { - "description": "VMware only: true if template is deployed without orchestrating disks and networks but \"as-is\" defined in the template.", - "name": "deployasis", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "checksum of the template", - "name": "checksum", + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", "type": "string" }, { - "description": "the template name", - "name": "name", + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", "type": "string" }, { - "description": "true if this template is a public template, false otherwise", - "name": "ispublic", - "type": "boolean" - }, - { - "description": "Lists the download progress of a template across all secondary storages", - "name": "downloaddetails", - "type": "list" - }, - { - "description": "true if template is sshkey enabled, false otherwise", - "name": "sshkeyenabled", - "type": "boolean" + "description": "the name of the virtual machine", + "name": "name", + "type": "string" }, { - "description": "the template ID of the parent template if present", - "name": "sourcetemplateid", + "description": "OS type id of the vm", + "name": "ostypeid", "type": "string" }, { - "description": "true if template requires HVM enabled, false otherwise", - "name": "requireshvm", - "type": "boolean" + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" }, { - "description": "the name of the domain to which the template belongs", - "name": "domain", + "description": "Guest vm Boot Type", + "name": "boottype", "type": "string" }, { - "description": "the physical size of the template", - "name": "physicalsize", - "type": "long" - } - ] - }, - { - "description": "lists network that are using a nicira nvp device", - "isasync": false, - "name": "listNiciraNvpDeviceNetworks", - "params": [ - { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, - { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" + "description": "the name of the host for the virtual machine", + "name": "hostname", + "type": "string" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "the state of the virtual machine", + "name": "state", "type": "string" }, { - "description": "nicira nvp device ID", - "length": 255, - "name": "nvpdeviceid", - "related": "addNiciraNvpDevice,listNiciraNvpDevices", - "required": true, - "type": "uuid" - } - ], - "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listF5LoadBalancerNetworks,listNetscalerLoadBalancerNetworks,listPaloAltoFirewallNetworks,listSrxFirewallNetworks,listBrocadeVcsDeviceNetworks", - "response": [ - { - "description": "the network's gateway", - "name": "gateway", + "description": "the user's name who deployed the virtual machine", + "name": "username", "type": "string" }, { - "description": "Name of the VPC to which this network belongs", - "name": "vpcname", + "description": "the ID of the host for the virtual machine", + "name": "hostid", "type": "string" }, { - "description": "the id of the network", - "name": "id", - "type": "string" + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "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": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", + "type": "boolean" }, { - "description": "the network domain", - "name": "networkdomain", + "description": "the project name of the vm", + "name": "project", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" }, { - "description": "the date this network was created", - "name": "created", - "type": "date" + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", + "type": "string" }, { - "description": "display text of the network offering the network is created from", - "name": "networkofferingdisplaytext", + "description": "the group name of the virtual machine", + "name": "group", "type": "string" }, { - "description": "true if network is system, false otherwise", - "name": "issystem", - "type": "boolean" + "description": "list of security groups associated with the virtual machine", + "name": "securitygroup", + "response": [ + { + "description": "the description of the security group", + "name": "description", + "type": "string" + }, + { + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" + }, + { + "description": "the domain ID of the security group", + "name": "domainid", + "type": "string" + }, + { + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" + }, + { + "description": "the list of ingress rules associated with the security group", + "name": "ingressrule", + "response": [ + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "the 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 ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "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": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + } + ], + "type": "set" + } + ], + "type": "set" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "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 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": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the name of the security group", + "name": "name", + "type": "string" + }, + { + "description": "the ID of the security group", + "name": "id", + "type": "string" + }, + { + "description": "the domain name of the security group", + "name": "domain", + "type": "string" + }, + { + "description": "the account owning the security group", + "name": "account", + "type": "string" + }, + { + "description": "the project id of the group", + "name": "projectid", + "type": "string" + }, + { + "description": "the project name of the group", + "name": "project", + "type": "string" + }, + { + "description": "the list of egress rules associated with the security group", + "name": "egressrule", + "response": [ + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "account owning the security group rule", + "name": "account", + "type": "string" + }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + } + ], + "type": "set" + } + ], + "type": "set" + } + ], + "type": "set" }, { - "description": "The vlan of the network. This parameter is visible to ROOT admins only", - "name": "vlan", + "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": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "the physical network id", - "name": "physicalnetworkid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the domain name of the network owner", - "name": "domain", + "description": "the account associated with the virtual machine", + "name": "account", "type": "string" }, { - "description": "true if network can span multiple zones", - "name": "strechedl2subnet", - "type": "boolean" + "description": "the group ID of the virtual machine", + "name": "groupid", + "type": "string" }, { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "Os type ID of the virtual machine", + "name": "guestosid", "type": "string" }, { - "description": "the traffic type of the network", - "name": "traffictype", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "description": "true network requires restart", - "name": "restartrequired", - "type": "boolean" + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" }, { - "description": "availability of the network offering the network is created from", - "name": "networkofferingavailability", + "description": "the ID of the virtual machine", + "name": "id", "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", + "type": "string" }, { - "description": "true if users from subdomains can access the domain level network", - "name": "subdomainaccess", - "type": "boolean" + "description": "the ID of the disk offering of the virtual machine", + "name": "diskofferingid", + "type": "string" }, { - "description": "the list of resource tags associated with network", - "name": "tags", + "description": "the list of nics associated with vm", + "name": "nic", "response": [ { - "description": "tag value", - "name": "value", + "description": "the type of the nic", + "name": "type", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "the name of the corresponding network", + "name": "networkname", "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": "the isolation uri of the nic", + "name": "isolationuri", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "the traffic type of the nic", + "name": "traffictype", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "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": "customer associated with the tag", - "name": "customer", + "description": "the gateway of the nic", + "name": "gateway", "type": "string" - } - ], - "type": "list" - }, - { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "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", - "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": "list networks that are persistent", - "name": "ispersistent", - "type": "boolean" - }, - { - "description": "the network's netmask", - "name": "netmask", - "type": "string" - }, - { - "description": "list networks available for vm deployment", - "name": "canusefordeploy", - "type": "boolean" - }, - { - "description": "true if network is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "the project 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 list of services", - "name": "service", - "response": [ + }, { - "description": "the list of capabilities", - "name": "capability", - "response": [ - { - "description": "the capability value", - "name": "value", - "type": "string" - }, - { - "description": "can this service capability value can be choosable while creatine network offerings", - "name": "canchooseservicecapability", - "type": "boolean" - }, - { - "description": "the capability name", - "name": "name", - "type": "string" - } - ], - "type": "list" + "description": "the ip address of the nic", + "name": "ipaddress", + "type": "string" }, { - "description": "the service name", - "name": "name", + "description": "the ID of the nic", + "name": "id", "type": "string" }, { - "description": "the service provider name", - "name": "provider", - "response": [ - { - "description": "state of the network provider", - "name": "state", - "type": "string" - }, - { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", - "type": "string" - }, - { - "description": "the destination physical network", - "name": "destinationphysicalnetworkid", - "type": "string" - }, - { - "description": "uuid of the network provider", - "name": "id", - "type": "string" - }, - { - "description": "true if individual services can be enabled/disabled", - "name": "canenableindividualservice", - "type": "boolean" - }, - { - "description": "the provider name", - "name": "name", - "type": "string" - }, - { - "description": "services for this provider", - "name": "servicelist", - "type": "list" - } - ], - "type": "list" + "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": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", + "type": "string" + }, + { + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", + "type": "string" + }, + { + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "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": "the netmask of the nic", + "name": "netmask", + "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" } ], - "type": "list" - }, - { - "description": "broadcast uri of the network. This parameter is visible to ROOT admins only", - "name": "broadcasturi", - "type": "string" - }, - { - "description": "ACL name associated with the VPC network", - "name": "aclname", - "type": "string" + "type": "set" }, { - "description": "the name of the zone the network belongs to", - "name": "zonename", + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", "type": "string" }, { - "description": "zone id of the network", - "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 cidr of IPv6 network", - "name": "ip6cidr", - "type": "string" + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" }, { - "description": "ACL Id associated with the VPC network", - "name": "aclid", - "type": "string" + "description": "the memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" }, { - "description": "the second DNS for the network", - "name": "dns2", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "network offering id the network is created from", - "name": "networkofferingid", + "description": "the pool type of the virtual machine", + "name": "pooltype", "type": "string" }, { - "description": "If a network is enabled for 'streched l2 subnet' then represents zones on which network currently spans", - "name": "zonesnetworkspans", - "type": "set" - }, - { - "description": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR", - "name": "cidr", + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", "type": "string" }, { - "description": "the type of the network", - "name": "type", + "description": "OS name of the vm", + "name": "osdisplayname", "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": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "the name of the network", - "name": "name", + "description": "the password (if exists) of the virtual machine", + "name": "password", "type": "string" }, { - "description": "Broadcast domain type of the network", - "name": "broadcastdomaintype", + "description": "State of the Service from LB rule", + "name": "servicestate", "type": "string" }, - {}, { - "description": "state of the network", - "name": "state", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "the displaytext of the network", - "name": "displaytext", + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", "type": "string" }, { - "description": "the owner of the network", - "name": "account", + "description": "the project id of the vm", + "name": "projectid", "type": "string" }, { - "description": "related to what other network configuration", - "name": "related", + "description": "the name of the disk offering of the virtual machine", + "name": "diskofferingname", "type": "string" }, { - "description": "true if network supports specifying ip ranges, false otherwise", - "name": "specifyipranges", - "type": "boolean" - }, - { - "description": "an optional field, whether to the display the network to the end user or not.", - "name": "displaynetwork", - "type": "boolean" - }, + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "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 ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + } + ], + "type": "set" + } + ], + "since": "3.0.0" + }, + { + "description": " delete a BigSwitch BCF Controller device", + "isasync": true, + "name": "deleteBigSwitchBcfDevice", + "params": [ { - "description": "the first DNS for the network", - "name": "dns1", - "type": "string" - }, + "description": "BigSwitch device ID", + "length": 255, + "name": "bcfdeviceid", + "related": "listBigSwitchBcfDevices", + "required": true, + "type": "uuid" + } + ], + "response": [ { - "description": "the domain id of the network owner", - "name": "domainid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "VPC the network belongs to", - "name": "vpcid", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, + {}, { - "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": "true if network offering is ip conserve mode enabled", - "name": "networkofferingconservemode", + "description": "true if operation is executed successfully", + "name": "success", "type": "boolean" } - ] - }, - { - "description": "Change ownership of a VM from one account to another. This API is available for Basic zones with security groups and Advanced zones with guest networks. A root administrator can reassign a VM from any account to any other account in any domain. A domain administrator can reassign a VM to any account in the same domain.", - "isasync": false, - "name": "assignVirtualMachine", + ], + "since": "4.6.0" + }, + { + "description": "configures a netscaler load balancer device", + "isasync": true, + "name": "configureNetscalerLoadBalancer", "params": [ { - "description": "domain id of the new VM owner.", + "description": "Netscaler load balancer device ID", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains,listDomains", - "required": false, + "name": "lbdeviceid", + "related": "addNetscalerLoadBalancer,configureNetscalerLoadBalancer,listNetscalerLoadBalancers,registerNetscalerControlCenter,deployNetscalerVpx", + "required": true, "type": "uuid" }, { - "description": "account name of the new VM owner.", + "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": "account", + "name": "lbdevicededicated", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "an optional project for the new VM owner.", + "description": "capacity of the device, Capacity will be interpreted as number of networks device can handle", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", + "name": "lbdevicecapacity", "required": false, - "type": "uuid" - }, - { - "description": "id of the VM to be moved", - "length": 255, - "name": "virtualmachineid", - "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,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" + "type": "long" }, { - "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": "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": "networkids", - "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listF5LoadBalancerNetworks,listNetscalerLoadBalancerNetworks,listPaloAltoFirewallNetworks,listSrxFirewallNetworks,listBrocadeVcsDeviceNetworks", + "name": "inline", "required": false, - "type": "list" + "type": "boolean" }, { - "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": "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": "securitygroupids", - "related": "createSecurityGroup", + "name": "podids", + "related": "updatePod,createManagementNetworkIpRange", "required": false, "type": "list" } ], - "related": "migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance", + "related": "addNetscalerLoadBalancer,listNetscalerLoadBalancers,registerNetscalerControlCenter,deployNetscalerVpx", "response": [ { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", + "description": "name of the provider", + "name": "provider", "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": "the date when this virtual machine was created", - "name": "created", - "type": "date" + "description": "the private interface of the load balancer", + "name": "privateinterface", + "type": "string" }, { - "description": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" + "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": "device capacity", + "name": "lbdevicecapacity", + "type": "long" }, { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", + "description": "true if NetScaler device is provisioned to be a GSLB service provider", + "name": "gslbprovider", "type": "boolean" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "device id of the netscaler load balancer", + "name": "lbdeviceid", "type": "string" }, { - "description": "the ID of the availablility zone for the virtual machine", - "name": "zoneid", + "description": "the physical network to which this netscaler device belongs to", + "name": "physicalnetworkid", "type": "string" }, { - "description": "the name of the disk offering of the virtual machine", - "name": "diskofferingname", + "description": "device state", + "name": "lbdevicestate", "type": "string" }, { - "description": "ssh key-pair", - "name": "keypair", + "description": "device name", + "name": "lbdevicename", "type": "string" }, + {}, { - "description": "the account associated with the virtual machine", - "name": "account", + "description": "the management IP address of the external load balancer", + "name": "ipaddress", "type": "string" }, + {}, { - "description": "the name of the virtual machine", - "name": "name", - "type": "string" + "description": "true if device is dedicated for an account", + "name": "lbdevicededicated", + "type": "boolean" }, { - "description": "the speed of each cpu", - "name": "cpuspeed", - "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": "the list of nics associated with vm", - "name": "nic", - "response": [ - { - "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": "isdefault", - "type": "boolean" - }, - { - "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 gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" - }, - { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", - "type": "string" - }, - { - "description": "the IPv6 address of network", - "name": "ip6address", - "type": "string" - }, - { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", - "type": "string" - }, - { - "description": "the 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 isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "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": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", - "type": "string" - }, - { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" - }, - { - "description": "Id of the 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 ip address of the nic", - "name": "ipaddress", - "type": "string" - }, - { - "description": "the isolation uri of the nic", - "name": "isolationuri", - "type": "string" - }, - { - "description": "Type of adapter if available", - "name": "adaptertype", - "type": "string" - }, - { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", - "type": "string" - }, - { - "description": "the ID of the corresponding network", - "name": "networkid", - "type": "string" - }, - { - "description": "true if nic is default, false otherwise", - "name": "macaddress", - "type": "string" - } - ], - "type": "set" + "description": "public IP of the NetScaler representing GSLB site", + "name": "gslbproviderpublicip", + "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": "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": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", + "description": "private IP of the NetScaler representing GSLB site", + "name": "gslbproviderprivateip", "type": "string" + } + ] + }, + { + "description": "Lists all available ovs elements.", + "isasync": false, + "name": "listOvsElements", + "params": [ + { + "description": "list ovs elements by network service provider id", + "length": 255, + "name": "nspid", + "related": "listNetworkServiceProviders,listTrafficTypes", + "required": false, + "type": "uuid" }, { - "description": "the vgpu type used by the virtual machine", - "name": "vgpu", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "the ID of the disk offering of the virtual machine", - "name": "diskofferingid", - "type": "string" + "description": "list network offerings by enabled state", + "length": 255, + "name": "enabled", + "required": false, + "type": "boolean" }, { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" + "description": "list ovs elements by id", + "length": 255, + "name": "id", + "related": "listOvsElements,configureOvsElement", + "required": false, + "type": "uuid" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + } + ], + "related": "configureOvsElement", + "response": [ + { + "description": "the project name of the address", + "name": "project", "type": "string" }, { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "State of the Service from LB rule", - "name": "servicestate", + "description": "the domain associated with the provider", + "name": "domain", "type": "string" }, { - "description": "the ID of the virtual machine", - "name": "id", + "description": "the account associated with the provider", + "name": "account", "type": "string" }, + {}, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "the physical network service provider id of the provider", + "name": "nspid", "type": "string" }, { - "description": "the user's name who deployed the virtual machine", - "name": "username", + "description": "the id of the ovs", + "name": "id", "type": "string" }, { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" + "description": "the project id of the ipaddress", + "name": "projectid", + "type": "string" }, { - "description": "the internal memory that's free in vm or zero if it can not be calculated", - "name": "memoryintfreekbs", - "type": "long" + "description": "the domain ID associated with the provider", + "name": "domainid", + "type": "string" }, { "description": "the current status of the latest async job acting on this object", @@ -44235,651 +45834,419 @@ "type": "integer" }, { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", + "description": "Enabled/Disabled the service provider", + "name": "enabled", "type": "boolean" }, + {} + ] + }, + { + "description": "associate a profile to a blade", + "isasync": true, + "name": "associateUcsProfileToBlade", + "params": [ { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", - "type": "string" - }, - { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", - "type": "string" - }, - { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "blade id", + "length": 255, + "name": "bladeid", + "related": "associateUcsProfileToBlade", + "required": true, + "type": "uuid" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "profile dn", + "length": 255, + "name": "profiledn", + "required": true, "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": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "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": "id of the resource", - "name": "resourceid", - "type": "string" - } - ], - "type": "set" - }, + "description": "ucs manager id", + "length": 255, + "name": "ucsmanagerid", + "related": "listUcsManagers,addUcsManager", + "required": true, + "type": "uuid" + } + ], + "related": "", + "response": [ { - "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 project name of the affinity group", - "name": "project", - "type": "string" - }, - { - "description": "the type of the affinity group", - "name": "type", - "type": "string" - }, - { - "description": "the project ID of the affinity group", - "name": "projectid", - "type": "string" - }, - { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" - }, - { - "description": "the description of the affinity group", - "name": "description", - "type": "string" - }, - { - "description": "the domain ID of the affinity group", - "name": "domainid", - "type": "string" - }, - { - "description": "the domain name of the affinity group", - "name": "domain", - "type": "string" - } - ], - "type": "set" + "description": "cloudstack host id this blade associates to", + "name": "hostid", + "type": "string" }, {}, { - "description": "Guest vm Boot Type", - "name": "boottype", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the outgoing network traffic on the host", - "name": "networkkbswrite", - "type": "long" + "description": "ucs blade dn", + "name": "bladedn", + "type": "string" }, { - "description": "the project name of the vm", - "name": "project", + "description": "ucs blade id", + "name": "id", "type": "string" }, + {}, { - "description": "the name of the host for the virtual machine", - "name": "hostname", + "description": "ucs manager id", + "name": "ucsmanagerid", "type": "string" }, { - "description": "the state of the virtual machine", - "name": "state", + "description": "associated ucs profile dn", + "name": "profiledn", "type": "string" }, { - "description": "the target memory in vm", - "name": "memorytargetkbs", - "type": "long" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + } + ] + }, + { + "description": "Deletes user from the project", + "isasync": true, + "name": "deleteUserFromProject", + "params": [ + { + "description": "Id of the user to be removed from the project", + "length": 255, + "name": "userid", + "related": "createUser,disableUser,enableUser,getUser,listUsers,lockUser,updateUser", + "required": true, + "type": "uuid" }, { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" + "description": "ID of the project to remove the user from", + "length": 255, + "name": "projectid", + "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", + "required": true, + "type": "uuid" + } + ], + "response": [ + {}, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, { - "description": "the pool type of the virtual machine", - "name": "pooltype", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, {}, { - "description": "the memory used by the vm", - "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 vm", - "name": "ostypeid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" - }, + } + ], + "since": "4.15.0" + }, + { + "description": "Updates a VMware datacenter details for a zone", + "isasync": false, + "name": "updateVmwareDc", + "params": [ { - "description": "the project id of the vm", - "name": "projectid", + "description": "The username required to connect to resource.", + "length": 255, + "name": "username", + "required": false, "type": "string" }, { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", + "description": "VMware datacenter name.", + "length": 255, + "name": "name", + "required": false, "type": "string" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "The name/IP of vCenter. Make sure it is IP address or full qualified domain name for host running vCenter server.", + "length": 255, + "name": "vcenter", + "required": false, "type": "string" }, { - "description": "the write (bytes) of disk on the vm", - "name": "diskkbswrite", - "type": "long" + "description": "The password for specified username.", + "length": 255, + "name": "password", + "required": false, + "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" + "description": "Specify if cluster level username/password/url and host level guid need to be updated as well. By default this is true.", + "length": 255, + "name": "isrecursive", + "required": false, + "type": "boolean" }, { - "description": "the read (bytes) of disk on the vm", - "name": "diskkbsread", - "type": "long" - }, + "description": "The zone ID", + "length": 255, + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": true, + "type": "uuid" + } + ], + "related": "addVmwareDc,listVmwareDcs", + "response": [ { - "description": "device type of the root volume", - "name": "rootdevicetype", + "description": "The VMware Datacenter ID", + "name": "id", "type": "string" }, { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", - "type": "string" + "description": "the Zone ID associated with this VMware Datacenter", + "name": "zoneid", + "type": "long" }, { - "description": "the number of cpu this virtual machine is running with", - "name": "cpunumber", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", + "description": "The VMware Datacenter name", + "name": "name", "type": "string" }, { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" - }, - { - "description": "the group ID of the virtual machine", - "name": "groupid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, + {}, { - "description": "the password (if exists) of the virtual machine", - "name": "password", + "description": "The VMware vCenter name/ip", + "name": "vcenter", "type": "string" + } + ], + "since": "4.12.0" + }, + { + "description": "Starts a router.", + "isasync": false, + "name": "getRouterHealthCheckResults", + "params": [ + { + "description": "if true is passed for this parameter, health checks are performed on the fly. Else last performed checks data is fetched", + "length": 255, + "name": "performfreshchecks", + "required": false, + "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 list of ingress rules associated with the security group", - "name": "ingressrule", - "response": [ - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the 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 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 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 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 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": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "the protocol of the security group rule", - "name": "protocol", - "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 description of the security group", - "name": "description", - "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": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the 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": "resource type", - "name": "resourcetype", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the account owning the security group", - "name": "account", - "type": "string" - }, - { - "description": "the project name of the group", - "name": "project", - "type": "string" - }, - { - "description": "the 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 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 ID of the router", + "length": 255, + "name": "routerid", + "related": "destroyRouter,listRouters,changeServiceForRouter,listInternalLoadBalancerVMs", + "required": true, + "type": "uuid" + } + ], + "related": "", + "response": [ + {}, + { + "description": "the id of the router", + "name": "healthchecks", + "type": "list" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the id of the router", + "name": "routerid", "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" }, + {} + ], + "since": "4.14.0" + }, + { + "description": "list control center", + "isasync": false, + "name": "listNetscalerControlCenter", + "params": [ + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, { - "description": "the read (io) of disk on the vm", - "name": "diskioread", - "type": "long" + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" }, { - "description": "OS name of the vm", - "name": "osdisplayname", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + } + ], + "related": "", + "response": [ + {}, + { + "description": "uuid", + "name": "uuid", "type": "string" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", + "description": "username", + "name": "username", "type": "string" }, + {}, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", + "description": "num_retries", + "name": "numretries", "type": "string" }, { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the group name of the virtual machine", - "name": "group", + "description": "id", + "name": "id", "type": "string" }, { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", + "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": "Resizes a volume", + "isasync": true, + "name": "resizeVolume", + "params": [ + { + "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 maximum number of IOPS", + "length": 255, + "name": "maxiops", + "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 disk volume", + "length": 255, + "name": "id", + "related": "attachVolume,createVolume,updateVolume,listVolumes,migrateVolume,resizeVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", + "required": true, + "type": "uuid" + }, + { + "description": "New minimum number of IOPS", + "length": 255, + "name": "miniops", + "required": false, + "type": "long" + } + ], + "related": "attachVolume,createVolume,updateVolume,listVolumes,migrateVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", + "response": [ + {}, + { + "description": "pod id of the volume", + "name": "podid", + "type": "string" + }, + { + "description": "IO requests write rate of the disk volume per the disk offering", + "name": "diskIopsWriteRate", + "type": "long" + }, + { + "description": "the date the disk volume was created", + "name": "created", "type": "date" }, { - "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 user's ID who deployed the virtual machine", - "name": "userid", + "description": "Hypervisor the volume belongs to", + "name": "hypervisor", "type": "string" }, { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", + "description": "the boolean state of whether the volume is destroyed or not", + "name": "destroyed", + "type": "boolean" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -44888,249 +46255,399 @@ "type": "string" }, { - "description": "the incoming network traffic on the vm", - "name": "networkkbsread", + "description": "type of the disk volume (ROOT or DATADISK)", + "name": "type", + "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", + "type": "string" + }, {}, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", + "description": "ID of the snapshot from which this volume was created", + "name": "snapshotid", "type": "string" }, { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", + "description": "shared or local storage", + "name": "storagetype", + "type": "string" + }, + { + "description": "provisioning type used to create volumes.", + "name": "provisioningtype", + "type": "string" + }, + { + "description": "name of the availability zone", + "name": "zonename", + "type": "string" + }, + { + "description": "need quiesce vm or not when taking snapshot", + "name": "quiescevm", "type": "boolean" - } - ], - "since": "3.0.0" - }, - { - "description": " delete a BigSwitch BCF Controller device", - "isasync": true, - "name": "deleteBigSwitchBcfDevice", - "params": [ + }, { - "description": "BigSwitch device ID", - "length": 255, - "name": "bcfdeviceid", - "related": "listBigSwitchBcfDevices", - "required": true, - "type": "uuid" - } - ], - "response": [ + "description": "the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached.", + "name": "deviceid", + "type": "long" + }, { - "description": "true if operation is executed successfully", - "name": "success", + "description": "the project id of the vpn", + "name": "projectid", + "type": "string" + }, + { + "description": "cluster id of the volume", + "name": "clusterid", + "type": "string" + }, + { + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" + }, + { + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", + "type": "string" + }, + { + "description": "name of the service offering for root disk", + "name": "serviceofferingname", + "type": "string" + }, + { + "description": "bytes write rate of the disk volume", + "name": "diskBytesWriteRate", + "type": "long" + }, + { + "description": "the display text of the service offering for root disk", + "name": "serviceofferingdisplaytext", + "type": "string" + }, + { + "description": "name of the primary storage hosting the disk volume", + "name": "storage", + "type": "string" + }, + { + "description": "the state of the disk volume", + "name": "state", + "type": "string" + }, + { + "description": "an optional field whether to the display the volume to the end user or not.", + "name": "displayvolume", "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "name of the disk volume", + "name": "name", "type": "string" }, - {}, - {}, + { + "description": "max iops of the disk volume", + "name": "maxiops", + "type": "long" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "name of the disk offering", + "name": "diskofferingname", + "type": "string" + }, + { + "description": "the account associated with the disk volume", + "name": "account", + "type": "string" + }, + { + "description": "name of the virtual machine", + "name": "vmname", + "type": "string" + }, + { + "description": "the write (IO) of disk on the vm", + "name": "diskiowrite", + "type": "long" + }, + { + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "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 ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + } + ], + "type": "set" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "ID of the disk volume", + "name": "id", "type": "string" - } - ], - "since": "4.6.0" - }, - { - "description": "configures a netscaler load balancer device", - "isasync": true, - "name": "configureNetscalerLoadBalancer", - "params": [ + }, { - "description": "Netscaler load balancer device ID", - "length": 255, - "name": "lbdeviceid", - "related": "addNetscalerLoadBalancer,configureNetscalerLoadBalancer,listNetscalerLoadBalancers,registerNetscalerControlCenter,deployNetscalerVpx", - "required": true, - "type": "uuid" + "description": "state of the virtual machine", + "name": "vmstate", + "type": "string" }, { - "description": "true if this netscaler device to dedicated for a account, false if the netscaler device will be shared by multiple accounts", - "length": 255, - "name": "lbdevicededicated", - "required": false, - "type": "boolean" + "description": "the bytes actually consumed on disk", + "name": "virtualsize", + "type": "long" }, { - "description": "Used when NetScaler device is provider of EIP service. This parameter represents the list of pod's, for which there exists a policy based route on datacenter L3 router to route pod's subnet IP to a NetScaler device.", - "length": 255, - "name": "podids", - "related": "updatePod,createManagementNetworkIpRange", - "required": false, - "type": "list" + "description": "the disk utilization", + "name": "utilization", + "type": "string" }, { - "description": "true if netscaler load balancer is intended to be used in in-line with firewall, false if netscaler load balancer will side-by-side with firewall", - "length": 255, - "name": "inline", - "required": false, + "description": "id of the primary storage hosting the disk volume; returned to admin user only", + "name": "storageid", + "type": "string" + }, + { + "description": "true if storage snapshot is supported for the volume, false otherwise", + "name": "supportsstoragesnapshot", "type": "boolean" }, { - "description": "capacity of the device, Capacity will be interpreted as number of networks device can handle", - "length": 255, - "name": "lbdevicecapacity", - "required": false, + "description": "the ID of the domain associated with the disk volume", + "name": "domainid", + "type": "string" + }, + { + "description": "the VM's disk read in KiB", + "name": "diskkbsread", "type": "long" - } - ], - "related": "addNetscalerLoadBalancer,listNetscalerLoadBalancers,registerNetscalerControlCenter,deployNetscalerVpx", - "response": [ + }, { - "description": "the private interface of the load balancer", - "name": "privateinterface", + "description": "the status of the volume", + "name": "status", "type": "string" }, { - "description": "the management IP address of the external load balancer", - "name": "ipaddress", + "description": "the domain associated with the disk volume", + "name": "domain", "type": "string" }, { - "description": "device capacity", - "name": "lbdevicecapacity", - "type": "long" + "description": "id of the virtual machine", + "name": "virtualmachineid", + "type": "string" }, { - "description": "true if NetScaler device is provisioned to be a GSLB service provider", - "name": "gslbprovider", + "description": "the date the volume was attached to a VM instance", + "name": "attached", + "type": "date" + }, + { + "description": "true if the volume is extractable, false otherwise", + "name": "isextractable", "type": "boolean" }, { - "description": "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 read (IO) of disk on the vm", + "name": "diskioread", + "type": "long" }, { - "description": "device name", - "name": "lbdevicename", + "description": "ID of the availability zone", + "name": "zoneid", "type": "string" }, { - "description": "private IP of the NetScaler representing GSLB site", - "name": "gslbproviderprivateip", + "description": "size of the disk volume", + "name": "size", + "type": "long" + }, + { + "description": "volume uuid that is given by virtualisation provider (only for VMware)", + "name": "externaluuid", "type": "string" }, { - "description": "true if device is dedicated for an account", - "name": "lbdevicededicated", - "type": "boolean" + "description": "pod name of the volume", + "name": "podname", + "type": "string" }, { - "description": "the public interface of the load balancer", - "name": "publicinterface", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, - {}, { - "description": "device state", - "name": "lbdevicestate", + "description": "bytes read rate of the disk volume", + "name": "diskBytesReadRate", + "type": "long" + }, + { + "description": "IO requests read rate of the disk volume per the disk offering", + "name": "diskIopsReadRate", + "type": "long" + }, + { + "description": "ID of the disk offering", + "name": "diskofferingid", + "type": "string" + }, + { + "description": "the path of the volume", + "name": "path", + "type": "string" + }, + { + "description": "cluster name where the volume is allocated", + "name": "clustername", "type": "string" }, - {}, { - "description": "true if NetScaler device is provisioned exclusively to be a GSLB service provider", - "name": "isexclusivegslbprovider", - "type": "boolean" + "description": "the display text of the disk offering", + "name": "diskofferingdisplaytext", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the project name of the vpn", + "name": "project", "type": "string" }, { - "description": "name of the provider", - "name": "provider", + "description": "the chain info of the volume", + "name": "chaininfo", "type": "string" }, { - "description": "the physical network to which this netscaler device belongs to", - "name": "physicalnetworkid", + "description": "ID of the service offering for root disk", + "name": "serviceofferingid", "type": "string" }, { - "description": "device id of the netscaler load balancer", - "name": "lbdeviceid", + "description": "display name of the virtual machine", + "name": "vmdisplayname", "type": "string" }, { - "description": "public IP of the NetScaler representing GSLB site", - "name": "gslbproviderpublicip", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "min iops of the disk volume", + "name": "miniops", + "type": "long" } ] }, { - "description": "Lists all available ovs elements.", - "isasync": false, - "name": "listOvsElements", + "description": "Deletes affinity group", + "isasync": true, + "name": "deleteAffinityGroup", "params": [ { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, - { - "description": "list network offerings by enabled state", + "description": "the project of the affinity group", "length": 255, - "name": "enabled", + "name": "projectid", + "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "list ovs elements by id", + "description": "the domain ID of account owning the affinity group", "length": 255, - "name": "id", - "related": "listOvsElements,configureOvsElement", + "name": "domainid", + "related": "listDomainChildren,listDomains,listDomains", "required": false, "type": "uuid" }, { - "description": "", + "description": "the account of the affinity group. Must be specified with domain ID", "length": 255, - "name": "pagesize", + "name": "account", "required": false, - "type": "integer" + "type": "string" }, { - "description": "List by keyword", + "description": "The name of the affinity group. Mutually exclusive with ID parameter", "length": 255, - "name": "keyword", + "name": "name", "required": false, "type": "string" }, { - "description": "list ovs elements by network service provider id", + "description": "The ID of the affinity group. Mutually exclusive with name parameter", "length": 255, - "name": "nspid", - "related": "listNetworkServiceProviders,listTrafficTypes", + "name": "id", + "related": "", "required": false, "type": "uuid" } ], - "related": "configureOvsElement", "response": [ { "description": "the UUID of the latest async job acting on this object", @@ -45138,16 +46655,11 @@ "type": "string" }, { - "description": "the physical network service provider id of the provider", - "name": "nspid", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, {}, - { - "description": "the domain associated with the provider", - "name": "domain", - "type": "string" - }, {}, { "description": "the current status of the latest async job acting on this object", @@ -45155,86 +46667,36 @@ "type": "integer" }, { - "description": "the project id of the ipaddress", - "name": "projectid", - "type": "string" - }, - { - "description": "the account associated with the provider", - "name": "account", - "type": "string" - }, - { - "description": "Enabled/Disabled the service provider", - "name": "enabled", + "description": "true if operation is executed successfully", + "name": "success", "type": "boolean" - }, - { - "description": "the id of the ovs", - "name": "id", - "type": "string" - }, - { - "description": "the domain ID associated with the provider", - "name": "domainid", - "type": "string" - }, - { - "description": "the project name of the address", - "name": "project", - "type": "string" } ] }, { - "description": "associate a profile to a blade", - "isasync": true, - "name": "associateUcsProfileToBlade", + "description": "Deletes a network offering.", + "isasync": false, + "name": "deleteNetworkOffering", "params": [ { - "description": "profile dn", - "length": 255, - "name": "profiledn", - "required": true, - "type": "string" - }, - { - "description": "ucs manager id", - "length": 255, - "name": "ucsmanagerid", - "related": "listUcsManagers,addUcsManager", - "required": true, - "type": "uuid" - }, - { - "description": "blade id", + "description": "the ID of the network offering", "length": 255, - "name": "bladeid", - "related": "associateUcsProfileToBlade", + "name": "id", + "related": "listNetworkOfferings", "required": true, "type": "uuid" } ], - "related": "", "response": [ - { - "description": "ucs blade dn", - "name": "bladedn", - "type": "string" - }, - { - "description": "associated ucs profile dn", - "name": "profiledn", - "type": "string" - }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "ucs blade id", - "name": "id", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, { @@ -45244,121 +46706,101 @@ }, {}, { - "description": "cloudstack host id this blade associates to", - "name": "hostid", - "type": "string" - }, - {}, - { - "description": "ucs manager id", - "name": "ucsmanagerid", - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" } - ] + ], + "since": "3.0.0" }, { - "description": "Deletes user from the project", + "description": "Deletes a Network Service Provider.", "isasync": true, - "name": "deleteUserFromProject", + "name": "deleteNetworkServiceProvider", "params": [ { - "description": "ID of the project to remove the user from", - "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", - "required": true, - "type": "uuid" - }, - { - "description": "Id of the user to be removed from the project", + "description": "the ID of the network service provider", "length": 255, - "name": "userid", - "related": "createUser,disableUser,enableUser,getUser,listUsers,lockUser,updateUser", + "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 current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + {}, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" - }, - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" } ], - "since": "4.15.0" + "since": "3.0.0" }, { - "description": "Updates a VMware datacenter details for a zone", + "description": "List network devices", "isasync": false, - "name": "updateVmwareDc", + "name": "listNetworkDevice", "params": [ { - "description": "The password for specified username.", + "description": "List by keyword", "length": 255, - "name": "password", + "name": "keyword", "required": false, "type": "string" }, { - "description": "The name/IP of vCenter. Make sure it is IP address or full qualified domain name for host running vCenter server.", + "description": "", "length": 255, - "name": "vcenter", + "name": "pagesize", "required": false, - "type": "string" - }, - { - "description": "The zone ID", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": true, - "type": "uuid" + "type": "integer" }, { - "description": "The username required to connect to resource.", + "description": "", "length": 255, - "name": "username", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { - "description": "VMware datacenter name.", + "description": "parameters for network device", "length": 255, - "name": "name", + "name": "networkdeviceparameterlist", "required": false, - "type": "string" + "type": "map" }, { - "description": "Specify if cluster level username/password/url and host level guid need to be updated as well. By default this is true.", + "description": "Network device type, now supports ExternalDhcp, PxeServer, NetscalerMPXLoadBalancer, NetscalerVPXLoadBalancer, NetscalerSDXLoadBalancer, F5BigIpLoadBalancer, JuniperSRXFirewall, PaloAltoFirewall", "length": 255, - "name": "isrecursive", + "name": "networkdevicetype", "required": false, - "type": "boolean" + "type": "string" } ], - "related": "addVmwareDc,listVmwareDcs", + "related": "addNetworkDevice", "response": [ + {}, { - "description": "The VMware vCenter name/ip", - "name": "vcenter", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "the UUID of the latest async job acting on this object", @@ -45366,120 +46808,162 @@ "type": "string" }, { - "description": "The VMware Datacenter ID", + "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 Zone ID associated with this VMware Datacenter", - "name": "zoneid", - "type": "long" + "description": "the ending IP address", + "length": 255, + "name": "endip", + "required": false, + "type": "string" }, - {}, { - "description": "The VMware Datacenter name", - "name": "name", + "description": "the beginning IP address", + "length": 255, + "name": "startip", + "required": false, "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - } - ], - "since": "4.12.0" - }, - { - "description": "Starts a router.", - "isasync": false, - "name": "getRouterHealthCheckResults", - "params": [ - { - "description": "if true is passed for this parameter, health checks are performed on the fly. Else last performed checks data is fetched", + "description": "Optional. the vlan the ip range sits on", "length": 255, - "name": "performfreshchecks", + "name": "vlan", "required": false, - "type": "boolean" + "type": "integer" }, { - "description": "the ID of the router", + "description": "UUID of storage network ip range", "length": 255, - "name": "routerid", - "related": "destroyRouter,listRouters,changeServiceForRouter,listInternalLoadBalancerVMs", + "name": "id", + "related": "createStorageNetworkIpRange,listStorageNetworkIpRange,updateStorageNetworkIpRange", "required": true, "type": "uuid" + }, + { + "description": "the netmask for storage network", + "length": 255, + "name": "netmask", + "required": false, + "type": "string" } ], - "related": "", + "related": "createStorageNetworkIpRange,listStorageNetworkIpRange", "response": [ - { - "description": "the id of the router", - "name": "routerid", - "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 gateway of the storage network IP range", + "name": "gateway", + "type": "string" + }, + { + "description": "the Pod uuid for the storage network IP range", + "name": "podid", + "type": "string" + }, + { + "description": "the Zone uuid of the storage network IP range", + "name": "zoneid", + "type": "string" + }, + { + "description": "the netmask of the storage network IP range", + "name": "netmask", "type": "string" }, {}, + { + "description": "the uuid of storage network IP range.", + "name": "id", + "type": "string" + }, + { + "description": "the end ip of the storage network IP range", + "name": "endip", + "type": "string" + }, + { + "description": "the start ip of the storage network IP range", + "name": "startip", + "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 id of the router", - "name": "healthchecks", - "type": "list" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" } ], - "since": "4.14.0" + "since": "3.0.0" }, { - "description": "list control center", - "isasync": false, - "name": "listNetscalerControlCenter", + "description": "Dedicates a Pod.", + "isasync": true, + "name": "dedicatePod", "params": [ { - "description": "List by keyword", + "description": "the ID of the containing domain", "length": 255, - "name": "keyword", - "required": false, - "type": "string" + "name": "domainid", + "related": "listDomainChildren,listDomains,listDomains", + "required": true, + "type": "uuid" }, { - "description": "", + "description": "the ID of the Pod", "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" + "name": "podid", + "related": "updatePod,createManagementNetworkIpRange", + "required": true, + "type": "uuid" }, { - "description": "", + "description": "the name of the account which needs dedication. Must be used with domainId.", "length": 255, - "name": "page", + "name": "account", "required": false, - "type": "integer" + "type": "string" } ], - "related": "", + "related": "listDedicatedPods", "response": [ { - "description": "num_retries", - "name": "numretries", + "description": "the Account Id to which the Pod is dedicated", + "name": "accountid", "type": "string" }, { - "description": "ncc_ip", - "name": "ipaddress", + "description": "the domain ID to which the Pod is dedicated", + "name": "domainid", "type": "string" }, + {}, { - "description": "id", - "name": "id", + "description": "the Name of the Pod", + "name": "podname", "type": "string" }, { @@ -45487,1338 +46971,1239 @@ "name": "jobstatus", "type": "integer" }, + {}, { - "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": "uuid", - "name": "uuid", + "description": "the ID of the dedicated resource", + "name": "id", "type": "string" }, { - "description": "username", - "name": "username", + "description": "the Dedication Affinity Group ID of the pod", + "name": "affinitygroupid", "type": "string" }, - {} + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + } ] }, { - "description": "Resizes a volume", - "isasync": true, - "name": "resizeVolume", + "description": "Lists Project roles in CloudStack", + "isasync": false, + "name": "listProjectRoles", "params": [ { - "description": "the ID of the disk volume", - "length": 255, - "name": "id", - "related": "attachVolume,createVolume,updateVolume,listVolumes,migrateVolume,resizeVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", - "required": true, - "type": "uuid" - }, - { - "description": "New volume size in GB", - "length": 255, - "name": "size", - "required": false, - "type": "long" - }, - { - "description": "New minimum number of IOPS", - "length": 255, - "name": "miniops", - "required": false, - "type": "long" - }, - { - "description": "Verify OK to Shrink", + "description": "List project role by project role name.", "length": 255, - "name": "shrinkok", + "name": "name", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "New maximum number of IOPS", + "description": "List by keyword", "length": 255, - "name": "maxiops", + "name": "keyword", "required": false, - "type": "long" + "type": "string" }, { - "description": "new disk offering id", + "description": "List project role by project role ID.", "length": 255, - "name": "diskofferingid", - "related": "createDiskOffering,listDiskOfferings", + "name": "projectroleid", + "related": "createProjectRole,listProjectRoles,updateProjectRole", "required": false, "type": "uuid" - } - ], - "related": "attachVolume,createVolume,updateVolume,listVolumes,migrateVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", - "response": [ - { - "description": "an optional field whether to the display the volume to the end user or not.", - "name": "displayvolume", - "type": "boolean" - }, - { - "description": "the date the disk volume was created", - "name": "created", - "type": "date" - }, - { - "description": "name of the virtual machine", - "name": "vmname", - "type": "string" - }, - { - "description": "the status of the volume", - "name": "status", - "type": "string" }, { - "description": "the bytes actually consumed on disk", - "name": "virtualsize", - "type": "long" + "description": "List project role by project ID.", + "length": 255, + "name": "projectid", + "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", + "required": true, + "type": "uuid" }, { - "description": "cluster id of the volume", - "name": "clusterid", - "type": "string" + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "the bytes allocated", - "name": "physicalsize", - "type": "long" - }, + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + } + ], + "related": "createProjectRole,updateProjectRole", + "response": [ { - "description": "the domain associated with the disk volume", - "name": "domain", + "description": "the ID of the role", + "name": "id", "type": "string" }, { - "description": "io requests read rate of the disk volume per the disk offering", - "name": "diskIopsReadRate", - "type": "long" + "description": "the description of the role", + "name": "description", + "type": "string" }, + {}, + {}, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "the id of the project", + "name": "projectid", "type": "string" }, { - "description": "the disk utilization", - "name": "utilization", + "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 name of the role", + "name": "name", + "type": "string" }, { - "description": "ID of the disk volume", + "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": "OpenDaylight Controller ID", + "length": 255, "name": "id", - "type": "string" - }, + "related": "addOpenDaylightController,deleteOpenDaylightController", + "required": true, + "type": "uuid" + } + ], + "related": "addOpenDaylightController", + "response": [ + {}, + {}, { - "description": "the state of the disk volume", - "name": "state", + "description": "device id of the controller", + "name": "id", "type": "string" }, { - "description": "cluster name where the volume is allocated", - "name": "clustername", + "description": "the physical network to which this controller belongs to", + "name": "physicalnetworkid", "type": "string" }, { - "description": "name of the disk volume", + "description": "the name assigned to the controller", "name": "name", "type": "string" }, { - "description": "id of the virtual machine", - "name": "virtualmachineid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the username to authenticate to the controller", + "name": "username", "type": "string" }, { - "description": "name of the service offering for root disk", - "name": "serviceofferingname", + "description": "the url of the controller api", + "name": "url", "type": "string" + } + ] + }, + { + "description": "Updates attributes of a template.", + "isasync": false, + "name": "updateTemplate", + "params": [ + { + "description": "Details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].hypervisortoolsversion=xenserver61", + "length": 255, + "name": "details", + "required": false, + "type": "map" }, { - "description": "ID of the availability zone", - "name": "zoneid", + "description": "true if image is bootable, false otherwise; available only for updateIso API", + "length": 255, + "name": "bootable", + "required": false, + "type": "boolean" + }, + { + "description": "the type of the template", + "length": 255, + "name": "templatetype", + "required": false, "type": "string" }, { - "description": "min iops of the disk volume", - "name": "miniops", - "type": "long" + "description": "optional boolean field, which indicates if details should be cleaned up or not (if set to true, details removed for this resource, details field ignored; if false or not set, no action)", + "length": 255, + "name": "cleanupdetails", + "required": false, + "type": "boolean" }, { - "description": "ID of the disk offering", - "name": "diskofferingid", - "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": "name of the primary storage hosting the disk volume", - "name": "storage", + "description": "the format for the image", + "length": 255, + "name": "format", + "required": false, "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "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 ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "the display text of the image", + "length": 4096, + "name": "displaytext", + "required": false, "type": "string" }, { - "description": "the project name of the vpn", - "name": "project", + "description": "the name of the image file", + "length": 255, + "name": "name", + "required": false, "type": "string" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", - "type": "string" + "description": "sort key of the template, integer", + "length": 255, + "name": "sortkey", + "required": false, + "type": "integer" }, { - "description": "state of the virtual machine", - "name": "vmstate", - "type": "string" + "description": "the ID of the image file", + "length": 255, + "name": "id", + "related": "listIsos,registerIso,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", + "required": true, + "type": "uuid" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", - "type": "string" + "description": "true if the template supports the sshkey upload feature; default is false", + "length": 255, + "name": "sshkeyenabled", + "required": false, + "type": "boolean" }, { - "description": "true if storage snapshot is supported for the volume, false otherwise", - "name": "supportsstoragesnapshot", + "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": "true if the image supports the password reset feature; default is false", + "length": 255, + "name": "passwordenabled", + "required": false, "type": "boolean" }, { - "description": "display name of the virtual machine", - "name": "vmdisplayname", + "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" + } + ], + "related": "listIsos,registerIso,createTemplate,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", + "response": [ + { + "description": "the template name", + "name": "name", "type": "string" }, { - "description": "ID of the service offering for root disk", - "name": "serviceofferingid", - "type": "string" + "description": "the physical size of the template", + "name": "physicalsize", + "type": "long" }, { - "description": "need quiesce vm or not when taking snapshot", - "name": "quiescevm", - "type": "boolean" + "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": "resource type", - "name": "resourcetype", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "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": "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 project id the tag belongs to", - "name": "projectid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the 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" } ], "type": "set" }, { - "description": "provisioning type used to create volumes.", - "name": "provisioningtype", - "type": "string" + "description": "true if the template is managed across all Zones, false otherwise", + "name": "crossZones", + "type": "boolean" }, { - "description": "pod name of the volume", - "name": "podname", + "description": "the template ID", + "name": "id", "type": "string" }, { - "description": "shared or local storage", - "name": "storagetype", - "type": "string" + "description": "true if template is sshkey enabled, false otherwise", + "name": "sshkeyenabled", + "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 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": "the processor bit size", + "name": "bits", + "type": "int" }, + {}, { - "description": "the boolean state of whether the volume is destroyed or not", - "name": "destroyed", - "type": "boolean" + "description": "the project name of the template", + "name": "project", + "type": "string" }, { - "description": "type of the disk volume (ROOT or DATADISK)", - "name": "type", + "description": "the status of the template", + "name": "status", "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": "VMware only: additional key/value details tied with deploy-as-is template", + "name": "deployasisdetails", + "type": "map" }, { - "description": "the write (io) of disk on the vm", - "name": "diskiowrite", - "type": "long" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "pod id of the volume", - "name": "podid", + "description": "the name of the OS type for this template.", + "name": "ostypename", "type": "string" }, { - "description": "the project id of the vpn", - "name": "projectid", - "type": "string" + "description": "true if the template is extractable, false otherwise", + "name": "isextractable", + "type": "boolean" }, { - "description": "Hypervisor the volume belongs to", - "name": "hypervisor", + "description": "the ID of the secondary storage host for the template", + "name": "hostid", "type": "string" }, { - "description": "ID of the snapshot from which this volume was created", - "name": "snapshotid", - "type": "string" + "description": "additional key/value details tied with template", + "name": "details", + "type": "map" }, { - "description": "the chain info of the volume", - "name": "chaininfo", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "id of the primary storage hosting the disk volume; returned to admin user only", - "name": "storageid", + "description": "the template display text", + "name": "displaytext", "type": "string" }, { - "description": "the path of the volume", - "name": "path", - "type": "string" + "description": "if root disk template, then ids of the datas disk templates this template owns", + "name": "childtemplates", + "type": "set" }, { - "description": "name of the disk offering", - "name": "diskofferingname", + "description": "the ID of the OS type for this template.", + "name": "ostypeid", "type": "string" }, { - "description": "bytes read rate of the disk volume", - "name": "diskBytesReadRate", - "type": "long" - }, - { - "description": "the display text of the disk offering", - "name": "diskofferingdisplaytext", - "type": "string" + "description": "the date this template was created", + "name": "created", + "type": "date" }, { - "description": "name of the availability zone", - "name": "zonename", + "description": "the type of the template", + "name": "templatetype", "type": "string" }, { - "description": "the account associated with the disk volume", - "name": "account", + "description": "the name of the domain to which the template belongs", + "name": "domain", "type": "string" }, { - "description": "the read (bytes) of disk on the vm", - "name": "diskkbsread", - "type": "long" - }, - { - "description": "bytes write rate of the disk volume", - "name": "diskBytesWriteRate", - "type": "long" - }, - { - "description": "the date the volume was attached to a VM instance", - "name": "attached", - "type": "date" + "description": "true if this template is a featured template, false otherwise", + "name": "isfeatured", + "type": "boolean" }, { - "description": "the ID of the domain associated with the disk volume", + "description": "the ID of the domain to which the template belongs", "name": "domainid", "type": "string" }, - {}, - { - "description": "the read (io) of disk on the vm", - "name": "diskioread", - "type": "long" - }, { - "description": "io requests write rate of the disk volume per the disk offering", - "name": "diskIopsWriteRate", - "type": "long" - }, - { - "description": "size of the disk volume", - "name": "size", - "type": "long" - }, - { - "description": "the display text of the service offering for root disk", - "name": "serviceofferingdisplaytext", + "description": "checksum of the template", + "name": "checksum", "type": "string" }, - {}, - { - "description": "the write (bytes) of disk on the vm", - "name": "diskkbswrite", - "type": "long" - }, - { - "description": "true if the volume is extractable, false otherwise", - "name": "isextractable", - "type": "boolean" - } - ] - }, - { - "description": "Deletes affinity group", - "isasync": true, - "name": "deleteAffinityGroup", - "params": [ { - "description": "the account of the affinity group. Must be specified with domain ID", - "length": 255, - "name": "account", - "required": false, + "description": "the template ID of the parent template if present", + "name": "sourcetemplateid", "type": "string" }, { - "description": "the project of the affinity group", - "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", - "required": false, - "type": "uuid" - }, - { - "description": "The name of the affinity group. Mutually exclusive with ID parameter", - "length": 255, - "name": "name", - "required": false, + "description": "the account id to which the template belongs", + "name": "accountid", "type": "string" }, { - "description": "The ID of the affinity group. Mutually exclusive with name parameter", - "length": 255, - "name": "id", - "related": "", - "required": false, - "type": "uuid" + "description": "Lists the download progress of a template across all secondary storages", + "name": "downloaddetails", + "type": "list" }, { - "description": "the domain ID of account owning the affinity group", - "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains,listDomains", - "required": false, - "type": "uuid" - } - ], - "response": [ - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" + "description": "true if template requires HVM enabled, false otherwise", + "name": "requireshvm", + "type": "boolean" }, - {}, - {}, { - "description": "true if operation is executed successfully", - "name": "success", + "description": "true if the ISO is bootable, false otherwise", + "name": "bootable", "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the format of the template.", + "name": "format", + "type": "imageformat" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - } - ] - }, - { - "description": "Deletes a network offering.", - "isasync": false, - "name": "deleteNetworkOffering", - "params": [ - { - "description": "the ID of the network offering", - "length": 255, - "name": "id", - "related": "listNetworkOfferings", - "required": true, - "type": "uuid" - } - ], - "response": [ - { - "description": "true if operation is executed successfully", - "name": "success", + "description": "true if this template is a public template, false otherwise", + "name": "ispublic", "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the date this template was removed", + "name": "removed", + "type": "date" }, - {}, - {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the tag of this template", + "name": "templatetag", "type": "string" - } - ], - "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": "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 the template is ready to be deployed from, false otherwise.", + "name": "isready", + "type": "boolean" }, - {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - } - ], - "since": "3.0.0" - }, - { - "description": "Dedicates a Pod.", - "isasync": true, - "name": "dedicatePod", - "params": [ - { - "description": "the name of the account which needs dedication. Must be used with domainId.", - "length": 255, - "name": "account", - "required": false, - "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 containing domain", - "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains,listDomains", - "required": true, - "type": "uuid" + "description": "the size of the template", + "name": "size", + "type": "long" }, { - "description": "the ID of the Pod", - "length": 255, - "name": "podid", - "related": "updatePod,createManagementNetworkIpRange", - "required": true, - "type": "uuid" - } - ], - "related": "listDedicatedPods", - "response": [ - {}, + "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", + "name": "isdynamicallyscalable", + "type": "boolean" + }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the ID of the zone for this template", + "name": "zoneid", "type": "string" }, + {}, { - "description": "the ID of the dedicated resource", - "name": "id", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the ID of the Pod", - "name": "podid", - "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 Dedication Affinity Group ID of the pod", - "name": "affinitygroupid", - "type": "string" + "description": "true if the reset password feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" }, { - "description": "the domain ID to which the Pod is dedicated", - "name": "domainid", + "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": "if Datadisk template, then id of the root disk template this template belongs to", + "name": "parenttemplateid", + "type": "string" }, { - "description": "the Account Id to which the Pod is dedicated", - "name": "accountid", + "description": "the project id of the template", + "name": "projectid", "type": "string" }, - {}, { - "description": "the Name of the Pod", - "name": "podname", + "description": "the name of the secondary storage host for the template", + "name": "hostname", "type": "string" } ] }, { - "description": "List network devices", + "description": "Creates a VLAN IP range.", "isasync": false, - "name": "listNetworkDevice", + "name": "createVlanIpRange", "params": [ { - "description": "", + "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": "page", + "name": "vlan", "required": false, - "type": "integer" + "type": "string" }, { - "description": "List by keyword", + "description": "the network id", "length": 255, - "name": "keyword", + "name": "networkid", + "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listPaloAltoFirewallNetworks,listSrxFirewallNetworks,listBrocadeVcsDeviceNetworks", "required": false, - "type": "string" + "type": "uuid" }, { - "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": "Network device type, now supports ExternalDhcp, PxeServer, NetscalerMPXLoadBalancer, NetscalerVPXLoadBalancer, NetscalerSDXLoadBalancer, F5BigIpLoadBalancer, JuniperSRXFirewall, PaloAltoFirewall", + "description": "the CIDR of IPv6 network, must be at least /64", "length": 255, - "name": "networkdevicetype", + "name": "ip6cidr", "required": false, "type": "string" }, { - "description": "parameters for network device", + "description": "the beginning IPv6 address in the IPv6 network range", "length": 255, - "name": "networkdeviceparameterlist", + "name": "startipv6", "required": false, - "type": "map" - } - ], - "related": "addNetworkDevice", - "response": [ - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", "type": "string" }, - {}, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { - "description": "the ID of the network device", - "name": "id", + "description": "the netmask of the VLAN IP range", + "length": 255, + "name": "netmask", + "required": false, "type": "string" - } - ] - }, - { - "description": "Update a Storage network IP range, only allowed when no IPs in this range have been allocated.", - "isasync": true, - "name": "updateStorageNetworkIpRange", - "params": [ + }, { - "description": "Optional. the vlan the ip range sits on", + "description": "true if IP range is set to system vms, false if not", "length": 255, - "name": "vlan", + "name": "forsystemvms", "required": false, - "type": "integer" + "type": "boolean" }, { - "description": "the ending IP address", + "description": "the gateway of the IPv6 network. Required for Shared networks and Isolated networks when it belongs to VPC", "length": 255, - "name": "endip", + "name": "ip6gateway", "required": false, "type": "string" }, { - "description": "UUID of storage network ip range", + "description": "the ending IP address in the VLAN IP range", "length": 255, - "name": "id", - "related": "createStorageNetworkIpRange,listStorageNetworkIpRange,updateStorageNetworkIpRange", - "required": true, - "type": "uuid" + "name": "endip", + "required": false, + "type": "string" }, { - "description": "the beginning IP address", + "description": "the gateway of the VLAN IP range", "length": 255, - "name": "startip", + "name": "gateway", "required": false, "type": "string" }, { - "description": "the netmask for storage network", + "description": "account who will own the VLAN. If VLAN is Zone wide, this parameter should be ommited", "length": 255, - "name": "netmask", + "name": "account", "required": false, "type": "string" - } - ], - "related": "createStorageNetworkIpRange,listStorageNetworkIpRange", - "response": [ - {}, + }, { - "description": "the Zone uuid of the storage network IP range", + "description": "the Zone ID of the VLAN IP range", + "length": 255, "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": false, + "type": "uuid" + }, + { + "description": "the ending IPv6 address in the IPv6 network range", + "length": 255, + "name": "endipv6", + "required": false, "type": "string" }, { - "description": "the start ip of the storage network IP range", + "description": "the beginning IP address in the VLAN IP range", + "length": 255, "name": "startip", + "required": false, "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "true if VLAN is of Virtual type, false if Direct", + "length": 255, + "name": "forvirtualnetwork", + "required": false, + "type": "boolean" }, { - "description": "the netmask of the storage network IP range", - "name": "netmask", - "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 storage network IP range", - "name": "gateway", - "type": "string" + "description": "project who will own the VLAN. If VLAN is Zone wide, this parameter should be ommited", + "length": 255, + "name": "projectid", + "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", + "required": false, + "type": "uuid" }, { - "description": "the ID or VID of the VLAN.", - "name": "vlan", - "type": "integer" - }, + "description": "the physical network id", + "length": 255, + "name": "physicalnetworkid", + "related": "createPhysicalNetwork", + "required": false, + "type": "uuid" + } + ], + "related": "updateVlanIpRange,listVlanIpRanges,dedicatePublicIpRange", + "response": [ { - "description": "the end ip of the storage network IP range", - "name": "endip", + "description": "the cidr of the VLAN IP range", + "name": "cidr", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "the uuid of storage network IP range.", + "description": "the virtual network for the VLAN IP range", + "name": "forvirtualnetwork", + "type": "boolean" + }, + { + "description": "the ID of the VLAN IP range", "name": "id", "type": "string" }, { - "description": "the Pod uuid for the storage network IP range", - "name": "podid", + "description": "the start ip of the VLAN IP range", + "name": "startip", "type": "string" }, + {}, { - "description": "the network uuid of storage network IP range", - "name": "networkid", - "type": "string" - } - ], - "since": "3.0.0" - }, - { - "description": "Lists Project roles in CloudStack", - "isasync": false, - "name": "listProjectRoles", - "params": [ + "description": "indicates whether VLAN IP range is dedicated to system vms or not", + "name": "forsystemvms", + "type": "boolean" + }, { - "description": "List project role by project ID.", - "length": 255, + "description": "the project id of the vlan range", "name": "projectid", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", - "required": true, - "type": "uuid" + "type": "string" }, { - "description": "List project role by project role ID.", - "length": 255, - "name": "projectroleid", - "related": "createProjectRole,listProjectRoles,updateProjectRole", - "required": false, - "type": "uuid" + "description": "the domain ID of the VLAN IP range", + "name": "domainid", + "type": "string" }, { - "description": "List project role by project role name.", - "length": 255, - "name": "name", - "required": false, + "description": "the description of the VLAN IP range", + "name": "description", "type": "string" - } - ], - "related": "createProjectRole,updateProjectRole", - "response": [ + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the name of the role", - "name": "name", + "description": "the start ipv6 of the VLAN IP range", + "name": "startipv6", "type": "string" }, { - "description": "the ID of the role", - "name": "id", + "description": "the network id of vlan range", + "name": "networkid", "type": "string" }, - {}, { - "description": "the id of the project", - "name": "projectid", + "description": "the Zone ID of the VLAN IP range", + "name": "zoneid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the Pod name for the VLAN IP range", + "name": "podname", "type": "string" }, - {}, { - "description": "the description of the role", - "name": "description", + "description": "the gateway of the VLAN IP range", + "name": "gateway", "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 name assigned to the controller", - "name": "name", + "description": "the domain name of the VLAN IP range", + "name": "domain", "type": "string" }, { - "description": "the physical network to which this controller belongs to", + "description": "the physical network this belongs to", "name": "physicalnetworkid", "type": "string" }, { - "description": "the username to authenticate to the controller", - "name": "username", + "description": "the project name of the vlan range", + "name": "project", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the end ip of the VLAN IP range", + "name": "endip", + "type": "string" }, { - "description": "device id of the controller", - "name": "id", + "description": "the end ipv6 of the VLAN IP range", + "name": "endipv6", "type": "string" }, - {}, { - "description": "the url of the controller api", - "name": "url", + "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", "type": "string" + }, + { + "description": "the account of the VLAN IP range", + "name": "account", + "type": "string" + }, + { + "description": "the netmask of the VLAN IP range", + "name": "netmask", + "type": "string" + }, + { + "description": "the Pod ID for the VLAN IP range", + "name": "podid", + "type": "string" + }, + {}, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" } ] }, { - "description": "Updates attributes of a template.", - "isasync": false, - "name": "updateTemplate", + "description": "Updates site to site vpn connection", + "isasync": true, + "name": "updateVpnConnection", "params": [ { - "description": "true if the template type is routing i.e., if template is used to deploy router", + "description": "id of vpn connection", "length": 255, - "name": "isrouting", - "required": false, - "type": "boolean" + "name": "id", + "related": "createVpnConnection,listVpnConnections,updateVpnConnection", + "required": true, + "type": "uuid" }, { - "description": "true if the image supports the password reset feature; default is false", + "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", "length": 255, - "name": "passwordenabled", + "name": "customid", "required": false, - "type": "boolean" + "since": "4.4", + "type": "string" }, { - "description": "Details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].hypervisortoolsversion=xenserver61", + "description": "an optional field, whether to the display the vpn to the end user or not", "length": 255, - "name": "details", + "name": "fordisplay", "required": false, - "type": "map" + "since": "4.4", + "type": "boolean" + } + ], + "related": "createVpnConnection,listVpnConnections", + "response": [ + { + "description": "the connection ID", + "name": "id", + "type": "string" }, + {}, + {}, { - "description": "sort key of the template, integer", - "length": 255, - "name": "sortkey", - "required": false, - "type": "integer" + "description": "the project id", + "name": "projectid", + "type": "string" }, { - "description": "the format for the image", - "length": 255, - "name": "format", - "required": false, + "description": "the vpn gateway ID", + "name": "s2svpngatewayid", "type": "string" }, { - "description": "the type of the template", - "length": 255, - "name": "templatetype", - "required": false, + "description": "the customer gateway ID", + "name": "s2scustomergatewayid", "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, + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "State of vpn connection", + "name": "passive", "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": "guest cidr list of the customer gateway. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", + "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 domain id of the owner", + "name": "domainid", + "type": "string" }, { - "description": "the ID of the image file", - "length": 255, - "name": "id", - "related": "listIsos,registerIso,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", - "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": "the display text of the image", - "length": 4096, - "name": "displaytext", - "required": false, + "description": "State of vpn connection", + "name": "state", "type": "string" }, { - "description": "true if the template requres HVM, false otherwise; available only for updateTemplate API", - "length": 255, - "name": "requireshvm", - "required": false, + "description": "Split multiple remote networks into multiple phase 2 SAs. Often used with Cisco some products.", + "name": "splitconnections", "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, + "description": "if Force NAT Encapsulation is enabled for customer gateway", + "name": "forceencap", "type": "boolean" }, { - "description": "true if the template supports the sshkey upload feature; default is false", - "length": 255, - "name": "sshkeyenabled", - "required": false, + "description": "is connection for display to the regular user", + "name": "fordisplay", "type": "boolean" }, { - "description": "the name of the image file", - "length": 255, - "name": "name", - "required": false, + "description": "IKE policy of the customer gateway", + "name": "ikepolicy", "type": "string" - } - ], - "related": "listIsos,registerIso,createTemplate,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", - "response": [ + }, { - "description": "the ID of the domain to which the template belongs", - "name": "domainid", + "description": "the public IP address", + "name": "publicip", "type": "string" }, { - "description": "true if the reset password feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" + "description": "Lifetime of IKE SA of customer gateway", + "name": "ikelifetime", + "type": "long" }, { - "description": "the name of the domain to which the template belongs", - "name": "domain", - "type": "string" + "description": "if DPD is enabled for customer gateway", + "name": "dpd", + "type": "boolean" }, { - "description": "the template display text", - "name": "displaytext", + "description": "ESP policy of the customer gateway", + "name": "esppolicy", "type": "string" }, { - "description": "if root disk template, then ids of the datas disk templates this template owns", - "name": "childtemplates", - "type": "set" + "description": "the date and time the host was created", + "name": "created", + "type": "date" }, { - "description": "the account name to which the template belongs", - "name": "account", + "description": "public ip address id of the customer gateway", + "name": "gateway", "type": "string" }, { - "description": "the date this template was removed", - "name": "removed", - "type": "date" - }, - { - "description": "VMware only: true if template is deployed without orchestrating disks and networks but \"as-is\" defined in the template.", - "name": "deployasis", - "type": "boolean" + "description": "Lifetime of ESP SA of customer gateway", + "name": "esplifetime", + "type": "long" }, { - "description": "the tag of this template", - "name": "templatetag", + "description": "the project name", + "name": "project", "type": "string" }, - {}, { - "description": "the name of the OS type for this template.", - "name": "ostypename", + "description": "IPsec Preshared-Key of the customer gateway", + "name": "ipsecpsk", "type": "string" }, - {}, { - "description": "Lists the download progress of a template across all secondary storages", - "name": "downloaddetails", - "type": "list" + "description": "the date and time the host was removed", + "name": "removed", + "type": "date" }, { - "description": "the status of the template", - "name": "status", + "description": "the domain name of the owner", + "name": "domain", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the owner", + "name": "account", "type": "string" - }, + } + ], + "since": "4.4" + }, + { + "description": "lists network that are using Palo Alto firewall device", + "isasync": false, + "name": "listPaloAltoFirewallNetworks", + "params": [ { - "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", - "name": "directdownload", - "type": "boolean" + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" }, { - "description": "the ID of the secondary storage host for the template", - "name": "hostid", - "type": "string" + "description": "palo alto balancer device ID", + "length": 255, + "name": "lbdeviceid", + "related": "addPaloAltoFirewall,configurePaloAltoFirewall,listPaloAltoFirewalls", + "required": true, + "type": "uuid" }, { - "description": "the processor bit size", - "name": "bits", - "type": "int" + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + } + ], + "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listSrxFirewallNetworks,listBrocadeVcsDeviceNetworks", + "response": [ { "description": "true if the entity/resource has annotations", "name": "hasannotations", "type": "boolean" }, { - "description": "the type of the template", - "name": "templatetype", + "description": "VPC the network belongs to", + "name": "vpcid", "type": "string" }, { - "description": "true if this template is a featured template, false otherwise", - "name": "isfeatured", - "type": "boolean" + "description": "display text of the network offering the network is created from", + "name": "networkofferingdisplaytext", + "type": "string" }, { - "description": "the project id of the template", - "name": "projectid", + "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": "the name of the Network associated with this private gateway", + "name": "associatednetwork", + "type": "string" }, { - "description": "VMware only: additional key/value details tied with deploy-as-is template", - "name": "deployasisdetails", - "type": "map" + "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 for this template.", - "name": "ostypeid", + "description": "the network's gateway", + "name": "gateway", "type": "string" }, { - "description": "the template ID of the parent template if present", - "name": "sourcetemplateid", + "description": "the network domain", + "name": "networkdomain", "type": "string" }, { - "description": "the account id to which the template belongs", - "name": "accountid", + "description": "the type of the network", + "name": "type", "type": "string" }, + {}, { - "description": "true if the ISO is bootable, false otherwise", - "name": "bootable", + "description": "true if network is default, false otherwise", + "name": "isdefault", "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "true if template requires HVM enabled, false otherwise", - "name": "requireshvm", + "description": "true if network is system, false otherwise", + "name": "issystem", "type": "boolean" }, { - "description": "the size of the template", - "name": "size", - "type": "long" + "description": "the second DNS for the network", + "name": "dns2", + "type": "string" }, { - "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", - "name": "isdynamicallyscalable", - "type": "boolean" + "description": "network offering id the network is created from", + "name": "networkofferingid", + "type": "string" }, { - "description": "the date this template was created", - "name": "created", - "type": "date" + "description": "the physical network id", + "name": "physicalnetworkid", + "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" }, { - "description": "the template name", - "name": "name", + "description": "The internet protocol of network offering", + "name": "internetprotocol", "type": "string" }, { - "description": "true if template is sshkey enabled, false otherwise", - "name": "sshkeyenabled", - "type": "boolean" - }, - { - "description": "the physical size of the template", - "name": "physicalsize", + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", "type": "long" }, { - "description": "if Datadisk template, then id of the root disk template this template belongs to", - "name": "parenttemplateid", - "type": "string" + "description": "true network requires restart", + "name": "restartrequired", + "type": "boolean" }, { - "description": "the URL which the template/iso is registered from", - "name": "url", + "description": "Broadcast domain type of the network", + "name": "broadcastdomaintype", "type": "string" }, { - "description": "the name of the zone for this template", + "description": "the name of the zone the network belongs to", "name": "zonename", "type": "string" }, { - "description": "true if the template is extractable, false otherwise", - "name": "isextractable", + "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", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "true if the template is ready to be deployed from, false otherwise.", - "name": "isready", - "type": "boolean" + "description": "the details of the network", + "name": "details", + "type": "map" }, + {}, { - "description": "the template ID", - "name": "id", + "description": "The routing mode of network offering", + "name": "ip6routing", "type": "string" }, { - "description": "the format of the template.", - "name": "format", - "type": "imageformat" + "description": "Name of the VPC to which this network belongs", + "name": "vpcname", + "type": "string" }, { - "description": "checksum of the template", - "name": "checksum", + "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", + "description": "the list of resource tags associated with network", "name": "tags", "response": [ { - "description": "the domain associated with the tag", - "name": "domain", + "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 account associated with the tag", - "name": "account", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", "type": "string" }, { @@ -46832,13 +48217,8 @@ "type": "string" }, { - "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" }, { @@ -46847,203 +48227,207 @@ "type": "string" } ], - "type": "set" + "type": "list" }, { - "description": "the name of the secondary storage host for the template", - "name": "hostname", + "description": "the project name of the address", + "name": "project", "type": "string" }, { - "description": "additional key/value details tied with template", - "name": "details", - "type": "map" + "description": "the first DNS for the network", + "name": "dns1", + "type": "string" }, { - "description": "true if this template is a public template, false otherwise", - "name": "ispublic", - "type": "boolean" + "description": "the name of the network", + "name": "name", + "type": "string" }, { - "description": "true if the template is managed across all Zones, false otherwise", - "name": "crossZones", + "description": "true if network can span multiple zones", + "name": "strechedl2subnet", "type": "boolean" }, { - "description": "the ID of the zone for this template", - "name": "zoneid", - "type": "string" - } - ] - }, - { - "description": "Creates a VLAN IP range.", - "isasync": false, - "name": "createVlanIpRange", - "params": [ - { - "description": "the CIDR of IPv6 network, must be at least /64", - "length": 255, - "name": "ip6cidr", - "required": false, - "type": "string" + "description": "list networks available for vm deployment", + "name": "canusefordeploy", + "type": "boolean" }, { - "description": "the beginning IPv6 address in the IPv6 network range", - "length": 255, - "name": "startipv6", - "required": false, - "type": "string" + "description": "the list of services", + "name": "service", + "response": [ + { + "description": "the service provider name", + "name": "provider", + "response": [ + { + "description": "uuid of the network provider", + "name": "id", + "type": "string" + }, + { + "description": "true if individual services can be enabled/disabled", + "name": "canenableindividualservice", + "type": "boolean" + }, + { + "description": "the destination physical network", + "name": "destinationphysicalnetworkid", + "type": "string" + }, + { + "description": "state of the network provider", + "name": "state", + "type": "string" + }, + { + "description": "services for this provider", + "name": "servicelist", + "type": "list" + }, + { + "description": "the provider name", + "name": "name", + "type": "string" + }, + { + "description": "the physical network this belongs to", + "name": "physicalnetworkid", + "type": "string" + } + ], + "type": "list" + }, + { + "description": "the list of capabilities", + "name": "capability", + "response": [ + { + "description": "the capability name", + "name": "name", + "type": "string" + }, + { + "description": "can this service capability value can be choosable while creatine network offerings", + "name": "canchooseservicecapability", + "type": "boolean" + }, + { + "description": "the capability value", + "name": "value", + "type": "string" + } + ], + "type": "list" + }, + { + "description": "the service name", + "name": "name", + "type": "string" + } + ], + "type": "list" }, { - "description": "the gateway of the IPv6 network. Required for Shared networks and Isolated networks when it belongs to VPC", - "length": 255, - "name": "ip6gateway", - "required": false, + "description": "name of the network offering the network is created from", + "name": "networkofferingname", "type": "string" }, { - "description": "the ending IPv6 address in the IPv6 network range", - "length": 255, - "name": "endipv6", - "required": false, + "description": "The external id of the network", + "name": "externalid", "type": "string" }, { - "description": "the ending IP address in the VLAN IP range", - "length": 255, - "name": "endip", - "required": false, + "description": "the network's netmask", + "name": "netmask", "type": "string" }, { - "description": "true if IP range is set to system vms, false if not", - "length": 255, - "name": "forsystemvms", - "required": false, + "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": "the network id", - "length": 255, - "name": "networkid", - "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listF5LoadBalancerNetworks,listNetscalerLoadBalancerNetworks,listPaloAltoFirewallNetworks,listSrxFirewallNetworks,listBrocadeVcsDeviceNetworks", - "required": false, - "type": "uuid" - }, - { - "description": "the beginning IP address in the VLAN IP range", - "length": 255, - "name": "startip", - "required": false, + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "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 physical network id", - "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork", - "required": false, - "type": "uuid" - }, - { - "description": "domain ID of the account owning a VLAN", - "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains,listDomains", - "required": false, - "type": "uuid" + "description": "state of the network", + "name": "state", + "type": "string" }, { - "description": "account who will own the VLAN. If VLAN is Zone wide, this parameter should be ommited", - "length": 255, - "name": "account", - "required": false, + "description": "the domain name of the network owner", + "name": "domain", "type": "string" }, { - "description": "true if VLAN is of Virtual type, false if Direct", - "length": 255, - "name": "forvirtualnetwork", - "required": false, + "description": "list networks that are persistent", + "name": "ispersistent", "type": "boolean" }, { - "description": "the gateway of the VLAN IP range", - "length": 255, - "name": "gateway", - "required": false, + "description": "true if users from subdomains can access the domain level network", + "name": "subdomainaccess", + "type": "boolean" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "the netmask of the VLAN IP range", - "length": 255, - "name": "netmask", - "required": false, + "description": "the owner of the network", + "name": "account", "type": "string" }, { - "description": "the ID or VID of the VLAN. If not specified, will be defaulted to the vlan of the network or if vlan of the network is null - to Untagged", - "length": 255, - "name": "vlan", - "required": false, + "description": "If a network is enabled for 'streched l2 subnet' then represents zones on which network currently spans", + "name": "zonesnetworkspans", + "type": "set" + }, + { + "description": "ACL name associated with the VPC network", + "name": "aclname", "type": "string" }, { - "description": "project who will own the VLAN. If VLAN is Zone wide, this parameter should be ommited", - "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", - "required": false, - "type": "uuid" - } - ], - "related": "updateVlanIpRange,listVlanIpRanges,dedicatePublicIpRange", - "response": [ + "description": "the date this network was created", + "name": "created", + "type": "date" + }, { - "description": "indicates whether VLAN IP range is dedicated to system vms or not", - "name": "forsystemvms", + "description": "true if network offering is ip conserve mode enabled", + "name": "networkofferingconservemode", "type": "boolean" }, { - "description": "the domain name of the VLAN IP range", - "name": "domain", - "type": "string" + "description": "true if network supports specifying ip ranges, false otherwise", + "name": "specifyipranges", + "type": "boolean" }, { - "description": "the project id of the vlan range", - "name": "projectid", + "description": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR", + "name": "cidr", "type": "string" }, { - "description": "the Pod name for the VLAN IP range", - "name": "podname", + "description": "the ID of the Network associated with this private gateway", + "name": "associatednetworkid", "type": "string" }, { - "description": "the end ip of the VLAN IP range", - "name": "endip", + "description": "ACL Id associated with the VPC network", + "name": "aclid", "type": "string" }, { - "description": "the description of the VLAN IP range", - "name": "description", + "description": "the name of the Network associated with this network", + "name": "associatednetwork", "type": "string" }, { @@ -47052,479 +48436,554 @@ "type": "integer" }, { - "description": "the Zone ID of the VLAN IP range", - "name": "zoneid", + "description": "the domain id of the network owner", + "name": "domainid", "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 cidr of IPv6 network", - "name": "ip6cidr", + "description": "availability of the network offering the network is created from", + "name": "networkofferingavailability", "type": "string" }, { - "description": "the network id of vlan range", - "name": "networkid", + "description": "the displaytext of the network", + "name": "displaytext", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the id of the network", + "name": "id", "type": "string" }, { - "description": "the gateway of the VLAN IP range", - "name": "gateway", + "description": "the network CIDR of the guest network configured with IP reservation. It is the summation of CIDR and RESERVED_IP_RANGE", + "name": "networkcidr", "type": "string" }, { - "description": "the ID or VID of the VLAN.", - "name": "vlan", + "description": "the traffic type of the network", + "name": "traffictype", "type": "string" }, { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", + "description": "The vlan of the network. This parameter is visible to ROOT admins only", + "name": "vlan", "type": "string" }, { - "description": "the start ipv6 of the VLAN IP range", - "name": "startipv6", - "type": "string" + "description": "The routes for the network to ease adding route in upstream router", + "name": "ip6routes", + "type": "set" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "the ID of the Network associated with this network", + "name": "associatednetworkid", "type": "string" }, { - "description": "the virtual network for the VLAN IP range", - "name": "forvirtualnetwork", + "description": "If the network has redundant routers enabled", + "name": "redundantrouter", "type": "boolean" }, { - "description": "the domain ID of the VLAN IP range", - "name": "domainid", + "description": "acl type - access type to the network", + "name": "acltype", "type": "string" }, { - "description": "the project name of the vlan range", - "name": "project", + "description": "zone id of the network", + "name": "zoneid", "type": "string" }, - {}, { - "description": "the end ipv6 of the VLAN IP range", - "name": "endipv6", - "type": "string" - }, + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + } + ] + }, + { + "description": "Get the path associated with the provided volume UUID", + "isasync": false, + "name": "getPathForVolume", + "params": [ { - "description": "the Pod ID for the VLAN IP range", - "name": "podid", + "description": "CloudStack Volume UUID", + "length": 255, + "name": "volumeid", + "required": true, "type": "string" - }, - {}, + } + ], + "related": "", + "response": [ { - "description": "the netmask of the VLAN IP range", - "name": "netmask", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the ID of the VLAN IP range", - "name": "id", - "type": "string" + "description": "the 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 path field for the volume", + "name": "path", "type": "string" - } + }, + {}, + {} ] }, { - "description": "Updates site to site vpn connection", - "isasync": true, - "name": "updateVpnConnection", + "description": "Lists management servers.", + "isasync": false, + "name": "listManagementServers", "params": [ { - "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", + "description": "the name of the management server", "length": 255, - "name": "customid", + "name": "name", "required": false, - "since": "4.4", "type": "string" }, { - "description": "an optional field, whether to the display the vpn to the end user or not", + "description": "List by keyword", "length": 255, - "name": "fordisplay", + "name": "keyword", "required": false, - "since": "4.4", - "type": "boolean" + "type": "string" }, { - "description": "id of vpn connection", + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "description": "the id of the management server", "length": 255, "name": "id", - "related": "createVpnConnection,listVpnConnections,updateVpnConnection", - "required": true, + "related": "listManagementServers", + "required": false, "type": "uuid" } ], - "related": "createVpnConnection,listVpnConnections", + "related": "", "response": [ { - "description": "the date and time the host was removed", - "name": "removed", - "type": "date" + "description": "the version of the java distribution running the management server process", + "name": "javaversion", + "type": "string" }, { - "description": "if Force NAT Encapsulation is enabled for customer gateway", - "name": "forceencap", - "type": "boolean" + "description": "the last time this Management Server was stopped", + "name": "lastserverstop", + "type": "date" }, { - "description": "IPsec Preshared-Key of the customer gateway", - "name": "ipsecpsk", + "description": "the name of the OS distribution running on the management server", + "name": "osdistribution", "type": "string" }, { - "description": "the domain id of the owner", - "name": "domainid", + "description": "the java distribution name running the management server process", + "name": "javadistribution", "type": "string" }, { - "description": "the date and time the host was created", - "name": "created", - "type": "date" - }, - { - "description": "public ip address id of the customer gateway", - "name": "gateway", + "description": "the ID of the management server", + "name": "id", "type": "string" }, { - "description": "the domain name of the owner", - "name": "domain", - "type": "string" + "description": "the last time the host on which this Management Server runs was booted", + "name": "lastboottime", + "type": "date" }, { - "description": "IKE policy of the customer gateway", - "name": "ikepolicy", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "State of vpn connection", - "name": "state", + "description": "the name of the management server", + "name": "name", "type": "string" }, { - "description": "is connection for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "State of vpn connection", - "name": "passive", - "type": "boolean" + "description": "the running OS kernel version for this Management Server", + "name": "kernelversion", + "type": "string" }, {}, { - "description": "the project name", - "name": "project", + "description": "the version of the management server", + "name": "version", "type": "string" }, { - "description": "the vpn gateway ID", - "name": "s2svpngatewayid", - "type": "string" + "description": "the last time this Management Server was started", + "name": "lastserverstart", + "type": "date" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the state of the management server", + "name": "state", + "type": "state" }, + {} + ] + }, + { + "description": "Updates a vm group", + "isasync": false, + "name": "updateInstanceGroup", + "params": [ { - "description": "Split multiple remote networks into multiple phase 2 SAs. Often used with Cisco some products.", - "name": "splitconnections", - "type": "boolean" + "description": "Instance group ID", + "length": 255, + "name": "id", + "related": "createInstanceGroup,updateInstanceGroup", + "required": true, + "type": "uuid" }, { - "description": "ESP policy of the customer gateway", - "name": "esppolicy", + "description": "new instance group name", + "length": 255, + "name": "name", + "required": false, "type": "string" - }, - {}, + } + ], + "related": "createInstanceGroup", + "response": [ { - "description": "the customer gateway ID", - "name": "s2scustomergatewayid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the connection ID", - "name": "id", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the domain ID of the instance group", + "name": "domainid", "type": "string" }, { - "description": "Lifetime of ESP SA of customer gateway", - "name": "esplifetime", - "type": "long" + "description": "time and date the instance group was created", + "name": "created", + "type": "date" }, { - "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": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the project name of the instance group", + "name": "project", "type": "string" }, { - "description": "guest cidr list of the customer gateway. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", + "description": "the project ID of the instance group", + "name": "projectid", "type": "string" }, { - "description": "the owner", + "description": "the account owning the instance group", "name": "account", "type": "string" }, { - "description": "if DPD is enabled for customer gateway", - "name": "dpd", - "type": "boolean" - }, - { - "description": "the public IP address", - "name": "publicip", + "description": "the ID of the instance group", + "name": "id", "type": "string" }, + {}, { - "description": "Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Defaults to ike", - "name": "ikeversion", + "description": "the name of the instance group", + "name": "name", "type": "string" }, + {}, { - "description": "the project id", - "name": "projectid", + "description": "the domain name of the instance group", + "name": "domain", "type": "string" } - ], - "since": "4.4" + ] }, { - "description": "lists network that are using Palo Alto firewall device", - "isasync": false, - "name": "listPaloAltoFirewallNetworks", + "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": "", + "description": "New minimum number of IOPS for the custom disk offering", "length": 255, - "name": "pagesize", + "name": "miniops", "required": false, - "type": "integer" + "type": "long" }, { - "description": "List by keyword", + "description": "Flag for automatic migration of the volume with new disk offering whenever migration is required to apply the offering", "length": 255, - "name": "keyword", + "name": "automigrate", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "palo alto balancer device ID", + "description": "new disk offering id", "length": 255, - "name": "lbdeviceid", - "related": "addPaloAltoFirewall,configurePaloAltoFirewall,listPaloAltoFirewalls", + "name": "diskofferingid", + "related": "createDiskOffering,listDiskOfferings", "required": true, "type": "uuid" }, { - "description": "", + "description": "Verify OK to Shrink", "length": 255, - "name": "page", + "name": "shrinkok", "required": false, - "type": "integer" + "type": "boolean" + }, + { + "description": "the ID of the volume", + "length": 255, + "name": "id", + "related": "attachVolume,createVolume,updateVolume,listVolumes,migrateVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", + "required": true, + "type": "uuid" + }, + { + "description": "New volume size in GB for the custom disk offering", + "length": 255, + "name": "size", + "required": false, + "type": "long" + }, + { + "description": "New maximum number of IOPS for the custom disk offering", + "length": 255, + "name": "maxiops", + "required": false, + "type": "long" } ], - "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listF5LoadBalancerNetworks,listNetscalerLoadBalancerNetworks,listSrxFirewallNetworks,listBrocadeVcsDeviceNetworks", + "related": "attachVolume,createVolume,updateVolume,listVolumes,migrateVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", "response": [ - {}, { - "description": "If the network has redundant routers enabled", - "name": "redundantrouter", - "type": "boolean" + "description": "the chain info of the volume", + "name": "chaininfo", + "type": "string" }, { - "description": "the name of the network", - "name": "name", + "description": "the state of the disk volume", + "name": "state", "type": "string" }, { - "description": "availability of the network offering the network is created from", - "name": "networkofferingavailability", + "description": "name of the disk volume", + "name": "name", "type": "string" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" + "description": "name of the availability zone", + "name": "zonename", + "type": "string" }, { - "description": "the network's gateway", - "name": "gateway", + "description": "cluster name where the volume is allocated", + "name": "clustername", "type": "string" }, { - "description": "VPC the network belongs to", - "name": "vpcid", + "description": "the path of the volume", + "name": "path", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", - "type": "string" + "description": "the date the disk volume was created", + "name": "created", + "type": "date" }, { - "description": "network offering id the network is created from", - "name": "networkofferingid", + "description": "need quiesce vm or not when taking snapshot", + "name": "quiescevm", + "type": "boolean" + }, + { + "description": "ID of the disk volume", + "name": "id", "type": "string" }, { - "description": "state of the network", - "name": "state", + "description": "ID of the snapshot from which this volume was created", + "name": "snapshotid", "type": "string" }, { - "description": "ACL Id associated with the VPC network", - "name": "aclid", + "description": "the ID of the domain associated with the disk volume", + "name": "domainid", "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "zone id of the network", - "name": "zoneid", + "description": "provisioning type used to create volumes.", + "name": "provisioningtype", "type": "string" }, - {}, { - "description": "the traffic type of the network", - "name": "traffictype", + "description": "name of the disk offering", + "name": "diskofferingname", "type": "string" }, { - "description": "Broadcast domain type of the network", - "name": "broadcastdomaintype", + "description": "name of the service offering for root disk", + "name": "serviceofferingname", "type": "string" }, { - "description": "the project name of the address", - "name": "project", + "description": "true if storage snapshot is supported for the volume, false otherwise", + "name": "supportsstoragesnapshot", + "type": "boolean" + }, + { + "description": "the project id of the vpn", + "name": "projectid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "ID of the service offering for root disk", + "name": "serviceofferingid", "type": "string" }, { - "description": "the domain name of the network owner", - "name": "domain", + "description": "cluster id of the volume", + "name": "clusterid", "type": "string" }, { - "description": "the network's netmask", - "name": "netmask", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", + "type": "string" + }, + { + "description": "max iops of the disk volume", + "name": "maxiops", + "type": "long" + }, + { + "description": "shared or local storage", + "name": "storagetype", "type": "string" }, { - "description": "acl type - access type to the network", - "name": "acltype", + "description": "the project name of the vpn", + "name": "project", "type": "string" }, { - "description": "name of the network offering the network is created from", - "name": "networkofferingname", - "type": "string" + "description": "the boolean state of whether the volume is destroyed or not", + "name": "destroyed", + "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 display text of the disk offering", + "name": "diskofferingdisplaytext", "type": "string" }, { - "description": "The vlan of the network. This parameter is visible to ROOT admins only", - "name": "vlan", + "description": "the account associated with the disk volume", + "name": "account", "type": "string" }, { - "description": "Name of the VPC to which this network belongs", - "name": "vpcname", + "description": "ID of the disk offering", + "name": "diskofferingid", "type": "string" }, { - "description": "the network domain", - "name": "networkdomain", + "description": "type of the disk volume (ROOT or DATADISK)", + "name": "type", "type": "string" }, { - "description": "the second DNS for the network", - "name": "dns2", - "type": "string" + "description": "IO requests write rate of the disk volume per the disk offering", + "name": "diskIopsWriteRate", + "type": "long" }, { - "description": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR", - "name": "cidr", - "type": "string" + "description": "min iops of the disk volume", + "name": "miniops", + "type": "long" }, { - "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": "true if network is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "the bytes actually consumed on disk", + "name": "virtualsize", + "type": "long" }, { - "description": "If a network is enabled for 'streched l2 subnet' then represents zones on which network currently spans", - "name": "zonesnetworkspans", - "type": "set" + "description": "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": "size of the disk volume", + "name": "size", + "type": "long" }, { - "description": "the name of the zone the network belongs to", - "name": "zonename", + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", "type": "string" }, { - "description": "true if network supports specifying ip ranges, false otherwise", - "name": "specifyipranges", - "type": "boolean" + "description": "bytes read rate of the disk volume", + "name": "diskBytesReadRate", + "type": "long" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "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": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "bytes write rate of the disk volume", + "name": "diskBytesWriteRate", + "type": "long" }, { "description": "the current status of the latest async job acting on this object", @@ -47532,37 +48991,27 @@ "type": "integer" }, { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "state of the virtual machine", + "name": "vmstate", "type": "string" }, { - "description": "true network requires restart", - "name": "restartrequired", + "description": "an optional field whether to the display the volume to the end user or not.", + "name": "displayvolume", "type": "boolean" }, { - "description": "The external id of the network", - "name": "externalid", - "type": "string" - }, - { - "description": "the domain id of the network owner", - "name": "domainid", - "type": "string" - }, - { - "description": "display text of the network offering the network is created from", - "name": "networkofferingdisplaytext", + "description": "Hypervisor the volume belongs to", + "name": "hypervisor", "type": "string" }, { - "description": "ACL name associated with the VPC network", - "name": "aclname", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { - "description": "the list of resource tags associated with network", + "description": "the list of resource tags associated", "name": "tags", "response": [ { @@ -47571,13 +49020,13 @@ "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { @@ -47586,23 +49035,23 @@ "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { @@ -47611,236 +49060,160 @@ "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - } - ], - "type": "list" - }, - { - "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 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 provider name", - "name": "name", - "type": "string" - }, - { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", - "type": "string" - }, - { - "description": "uuid of the network provider", - "name": "id", - "type": "string" - }, - { - "description": "the destination physical network", - "name": "destinationphysicalnetworkid", - "type": "string" - }, - { - "description": "services for this provider", - "name": "servicelist", - "type": "list" - }, - { - "description": "state of the network provider", - "name": "state", - "type": "string" - } - ], - "type": "list" - }, - { - "description": "the service name", - "name": "name", + "description": "customer associated with the tag", + "name": "customer", "type": "string" } ], - "type": "list" + "type": "set" }, { - "description": "the details of the network", - "name": "details", - "type": "map" + "description": "the status of the volume", + "name": "status", + "type": "string" }, { - "description": "the owner of the network", - "name": "account", + "description": "id of the primary storage hosting the disk volume; returned to admin user only", + "name": "storageid", "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": "pod id of the volume", + "name": "podid", "type": "string" }, { - "description": "true if network can span multiple zones", - "name": "strechedl2subnet", + "description": "true if the volume is extractable, false otherwise", + "name": "isextractable", "type": "boolean" }, { - "description": "the physical network id", - "name": "physicalnetworkid", + "description": "the disk utilization", + "name": "utilization", "type": "string" }, { - "description": "the type of the network", - "name": "type", + "description": "display name of the virtual machine", + "name": "vmdisplayname", "type": "string" }, { - "description": "true if users from subdomains can access the domain level network", - "name": "subdomainaccess", - "type": "boolean" + "description": "pod name of the volume", + "name": "podname", + "type": "string" }, + {}, { - "description": "the id of the network", - "name": "id", + "description": "name of the primary storage hosting the disk volume", + "name": "storage", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "ID of the availability zone", + "name": "zoneid", + "type": "string" }, { - "description": "broadcast uri of the network. This parameter is visible to ROOT admins only", - "name": "broadcasturi", + "description": "name of the virtual machine", + "name": "vmname", "type": "string" }, { - "description": "an optional field, whether to the display the network to the end user or not.", - "name": "displaynetwork", - "type": "boolean" + "description": "IO requests read rate of the disk volume per the disk offering", + "name": "diskIopsReadRate", + "type": "long" }, { - "description": "true if network is system, false otherwise", - "name": "issystem", - "type": "boolean" + "description": "the read (IO) of disk on the vm", + "name": "diskioread", + "type": "long" }, { - "description": "the displaytext of the network", - "name": "displaytext", - "type": "string" + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" }, { - "description": "the first DNS for the network", - "name": "dns1", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "related to what other network configuration", - "name": "related", + "description": "volume uuid that is given by virtualisation provider (only for VMware)", + "name": "externaluuid", "type": "string" }, { - "description": "true if network offering is ip conserve mode enabled", - "name": "networkofferingconservemode", - "type": "boolean" + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" }, { - "description": "the date this network was created", - "name": "created", - "type": "date" - } - ] - }, - { - "description": "Get the path associated with the provided volume UUID", - "isasync": false, - "name": "getPathForVolume", - "params": [ - { - "description": "CloudStack Volume UUID", - "length": 255, - "name": "volumeid", - "required": true, + "description": "the display text of the service offering for root disk", + "name": "serviceofferingdisplaytext", "type": "string" - } - ], - "related": "", - "response": [ + }, { - "description": "The path field for the volume", - "name": "path", + "description": "id of the virtual machine", + "name": "virtualmachineid", "type": "string" }, {}, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the 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", + "description": "the write (IO) of disk on the vm", + "name": "diskiowrite", + "type": "long" + }, + { + "description": "the bytes allocated", + "name": "physicalsize", + "type": "long" + }, + { + "description": "the domain associated with the disk volume", + "name": "domain", + "type": "string" + }, + { + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" } - ] + ], + "since": "4.17" }, { - "description": "Lists management servers.", + "description": "List the uploaded certificates for direct download templates", "isasync": false, - "name": "listManagementServers", + "name": "listTemplateDirectDownloadCertificates", "params": [ { - "description": "the name of the management server", + "description": "", "length": 255, - "name": "name", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { - "description": "the id of the management server", + "description": "the zone where certificates are uploaded", "length": 255, - "name": "id", - "related": "listManagementServers", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, "type": "uuid" }, { - "description": "", + "description": "list direct download certificate by ID", "length": 255, - "name": "page", + "name": "id", + "related": "uploadTemplateDirectDownloadCertificate,listTemplateDirectDownloadCertificates", "required": false, - "type": "integer" + "type": "uuid" }, { "description": "List by keyword", @@ -47855,131 +49228,100 @@ "name": "pagesize", "required": false, "type": "integer" + }, + { + "description": "if set to true: include the hosts where the certificate is uploaded to", + "length": 255, + "name": "listhosts", + "required": false, + "type": "boolean" } ], - "related": "", + "related": "uploadTemplateDirectDownloadCertificate", "response": [ { - "description": "the state of the management server", - "name": "state", - "type": "state" - }, - { - "description": "the version of the management server", - "name": "version", + "description": "the UUID of the latest async job acting on 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 zone id where the certificate is uploaded", + "name": "zoneid", "type": "string" }, - {}, { - "description": "the ID of the management server", + "description": "the direct download certificate id", "name": "id", "type": "string" }, { - "description": "the name of the management server", - "name": "name", + "description": "the zone name where the certificate is uploaded", + "name": "zonename", "type": "string" - } - ] - }, - { - "description": "Updates a vm group", - "isasync": false, - "name": "updateInstanceGroup", - "params": [ - { - "description": "Instance group ID", - "length": 255, - "name": "id", - "related": "createInstanceGroup,updateInstanceGroup", - "required": true, - "type": "uuid" }, { - "description": "new instance group name", - "length": 255, - "name": "name", - "required": false, + "description": "the direct download certificate subject", + "name": "subject", "type": "string" - } - ], - "related": "createInstanceGroup", - "response": [ - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" }, { - "description": "the domain ID of the instance group", - "name": "domainid", + "description": "the direct download certificate serial num", + "name": "serialnum", "type": "string" }, { - "description": "the name of the instance group", - "name": "name", - "type": "string" + "description": "the hosts where the certificate is uploaded to", + "name": "hostsmap", + "type": "list" }, { - "description": "the domain name of the instance group", - "name": "domain", + "description": "the direct download certificate issuer", + "name": "issuer", "type": "string" }, { - "description": "the project ID of the instance group", - "name": "projectid", + "description": "the direct download certificate version", + "name": "version", "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 hypervisor of the hosts where the certificate is uploaded", + "name": "hypervisor", "type": "string" }, {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "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 direct download certificate alias", + "name": "alias", "type": "string" }, { - "description": "the ID of the instance group", - "name": "id", + "description": "the direct download certificate issuer", + "name": "validity", "type": "string" } - ] + ], + "since": "4.17.0" }, { "description": "List ucs manager", "isasync": false, "name": "listUcsManagers", "params": [ + { + "description": "the ID of the ucs manager", + "length": 255, + "name": "id", + "related": "listUcsManagers,addUcsManager", + "required": false, + "type": "uuid" + }, { "description": "the zone id", "length": 255, @@ -47996,12 +49338,11 @@ "type": "integer" }, { - "description": "the ID of the ucs manager", + "description": "", "length": 255, - "name": "id", - "related": "listUcsManagers,addUcsManager", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" }, { "description": "List by keyword", @@ -48009,47 +49350,40 @@ "name": "keyword", "required": false, "type": "string" - }, - { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" } ], "related": "addUcsManager", "response": [ - { - "description": "the name of ucs manager", - "name": "name", - "type": "string" - }, - { - "description": "the zone ID of ucs manager", - "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 ID of the ucs manager", "name": "id", "type": "string" }, - {}, - {}, { "description": "the url of ucs manager", "name": "url", "type": "string" }, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the zone ID of ucs manager", + "name": "zoneid", + "type": "string" + }, + {}, + { + "description": "the name of ucs manager", + "name": "name", "type": "string" } ] @@ -48079,28 +49413,24 @@ "related": "destroyRouter,listRouters,listInternalLoadBalancerVMs", "response": [ { - "description": "the project name of the address", - "name": "project", - "type": "string" - }, - { - "description": "the public netmask for the router", - "name": "publicnetmask", + "description": "the hostname for the router", + "name": "hostname", "type": "string" }, - { - "description": "role of the domain router", - "name": "role", + {}, + { + "description": "the version of the code / software in the router", + "name": "softwareversion", "type": "string" }, { - "description": "the domain associated with the router", - "name": "domain", + "description": "the network domain for the router", + "name": "networkdomain", "type": "string" }, { - "description": "the first DNS for the router", - "name": "dns1", + "description": "the name of the corresponding guest network", + "name": "guestnetworkname", "type": "string" }, { @@ -48109,68 +49439,95 @@ "type": "string" }, { - "description": "the name of the corresponding guest network", - "name": "guestnetworkname", + "description": "the project name of the address", + "name": "project", "type": "string" }, { - "description": "the account associated with the router", - "name": "account", + "description": "the second IPv6 DNS for the router", + "name": "ip6dns2", "type": "string" }, { - "description": "the link local MAC address for the router", - "name": "linklocalmacaddress", + "description": "the public IP address for the router", + "name": "publicip", "type": "string" }, { - "description": "VPC the router belongs to", - "name": "vpcid", + "description": "the project id of the ipaddress", + "name": "projectid", "type": "string" }, { - "description": "the host ID for the router", - "name": "hostid", + "description": "the second DNS for the router", + "name": "dns2", "type": "string" }, { - "description": "true if the router template requires upgrader", - "name": "requiresupgrade", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "the Pod name for the router", - "name": "podname", + "description": "the link local MAC address for the router", + "name": "linklocalmacaddress", "type": "string" }, { - "description": "the link local IP address for the router", - "name": "linklocalip", - "type": "string" + "description": "true if the router template requires upgrader", + "name": "requiresupgrade", + "type": "boolean" }, { - "description": "the public MAC address for the router", - "name": "publicmacaddress", + "description": "the guest IP address for the router", + "name": "guestipaddress", "type": "string" }, { - "description": "the second IPv6 DNS for the router", - "name": "ip6dns2", + "description": "the Pod name for the router", + "name": "podname", "type": "string" }, { - "description": "the Zone ID for the router", - "name": "zoneid", - "type": "string" + "description": "Last executed health check result for the router", + "name": "healthcheckresults", + "response": [ + { + "description": "result of the health check", + "name": "success", + "type": "boolean" + }, + { + "description": "the type of the health check - basic or advanced", + "name": "checktype", + "type": "string" + }, + { + "description": "the date this VPC was created", + "name": "lastupdated", + "type": "date" + }, + { + "description": "the name of the health check on the router", + "name": "checkname", + "type": "string" + }, + { + "description": "detailed response generated on running health check", + "name": "details", + "type": "string" + } + ], + "type": "list" }, { - "description": "the name of VPC the router belongs to", - "name": "vpcname", + "description": "the link local IP address for the router", + "name": "linklocalip", "type": "string" }, { - "description": "the public IP address for the router", - "name": "publicip", + "description": "the version of scripts", + "name": "scriptsversion", "type": "string" }, { @@ -48179,88 +49536,83 @@ "type": "date" }, { - "description": "the hostname for the router", - "name": "hostname", - "type": "string" + "description": "the state of the router", + "name": "state", + "type": "state" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "the guest MAC address for the router", + "name": "guestmacaddress", "type": "string" }, { - "description": "the 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": "VPC the router belongs to", + "name": "vpcid", "type": "string" }, { - "description": "the guest MAC address for the router", - "name": "guestmacaddress", + "description": "the first IPv6 DNS for the router", + "name": "ip6dns1", "type": "string" }, { - "description": "the state of redundant virtual router", - "name": "redundantstate", + "description": "the public netmask for the router", + "name": "publicnetmask", "type": "string" }, { - "description": "the Zone name for the router", - "name": "zonename", + "description": "the first DNS for the router", + "name": "dns1", "type": "string" }, { - "description": "the id of the router", - "name": "id", - "type": "string" + "description": "true if any health checks had failed", + "name": "healthchecksfailed", + "type": "boolean" }, { - "description": "the network domain for the router", - "name": "networkdomain", + "description": "the name of VPC the router belongs to", + "name": "vpcname", "type": "string" }, { - "description": "the domain ID associated with the router", - "name": "domainid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the ID of the corresponding guest network", - "name": "guestnetworkid", + "description": "the host ID for the router", + "name": "hostid", "type": "string" }, { - "description": "the guest IP address for the router", - "name": "guestipaddress", + "description": "the link local netmask for the router", + "name": "linklocalnetmask", "type": "string" }, { - "description": "if this router is an redundant virtual router", - "name": "isredundantrouter", - "type": "boolean" + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", + "type": "string" }, { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "the domain associated with the router", + "name": "domain", "type": "string" }, { - "description": "the ID of the corresponding public network", - "name": "publicnetworkid", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the name of the router", - "name": "name", + "description": "the Zone name for the router", + "name": "zonename", "type": "string" }, { - "description": "the template name for the router", - "name": "templatename", + "description": "the domain ID associated with the router", + "name": "domainid", "type": "string" }, { @@ -48269,111 +49621,42 @@ "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", - "type": "string" - }, - { - "description": "the second DNS for the router", - "name": "dns2", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, { - "description": "true if any health checks had failed", - "name": "healthchecksfailed", - "type": "boolean" - }, - { - "description": "Last executed health check result for the router", - "name": "healthcheckresults", + "description": "the list of nics associated with the router", + "name": "nic", "response": [ { - "description": "result of the health check", - "name": "success", - "type": "boolean" + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" }, { - "description": "the name of the health check on the router", - "name": "checkname", + "description": "the isolation uri of the nic", + "name": "isolationuri", "type": "string" }, { - "description": "the type of the health check - basic or advanced", - "name": "checktype", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "detailed response generated on running health check", - "name": "details", + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", "type": "string" }, { - "description": "the date this VPC was created", - "name": "lastupdated", - "type": "date" - } - ], - "type": "list" - }, - { - "description": "the link local netmask for the router", - "name": "linklocalnetmask", - "type": "string" - }, - { - "description": "the Pod ID for the router", - "name": "podid", - "type": "string" - }, - { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", - "type": "string" - }, - { - "description": "the first IPv6 DNS for the router", - "name": "ip6dns1", - "type": "string" - }, - { - "description": "the gateway for the router", - "name": "gateway", - "type": "string" - }, - { - "description": "the version of template", - "name": "version", - "type": "string" - }, - { - "description": "the version of scripts", - "name": "scriptsversion", - "type": "string" - }, - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the state of the router", - "name": "state", - "type": "state" - }, - {}, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the list of nics associated with the router", - "name": "nic", - "response": [ + "description": "the IPv6 address of network", + "name": "ip6address", + "type": "string" + }, { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "true if nic is default, false otherwise", + "name": "macaddress", "type": "string" }, { @@ -48387,23 +49670,13 @@ "type": "string" }, { - "description": "the netmask of the nic", - "name": "netmask", + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", "type": "string" }, { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" - }, - { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "the ID of the corresponding network", + "name": "networkid", "type": "string" }, { @@ -48412,9 +49685,9 @@ "type": "string" }, { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", - "type": "string" + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" }, { "description": "Id of the vm to which the nic belongs", @@ -48422,43 +49695,38 @@ "type": "string" }, { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "the ID of the nic", - "name": "id", + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", "type": "string" }, { - "description": "the IPv6 address of network", - "name": "ip6address", + "description": "the type of the nic", + "name": "type", "type": "string" }, { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", - "type": "string" + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" }, { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "description": "the gateway of the nic", + "name": "gateway", "type": "string" }, { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "the ip address of the nic", + "name": "ipaddress", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "the netmask of the nic", + "name": "netmask", "type": "string" }, { @@ -48467,24 +49735,29 @@ "type": "string" }, { - "description": "the type of the nic", - "name": "type", + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", "type": "string" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", "type": "string" }, { - "description": "the gateway of the nic", - "name": "gateway", + "description": "the name of the corresponding network", + "name": "networkname", "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": "true if nic is default, false otherwise", @@ -48492,17 +49765,93 @@ "type": "boolean" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", - "type": "string" - }, - { - "description": "the ip address of the nic", - "name": "ipaddress", + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" } ], "type": "set" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the ID of the corresponding guest network", + "name": "guestnetworkid", + "type": "string" + }, + { + "description": "the ID of the corresponding link local network", + "name": "linklocalnetworkid", + "type": "string" + }, + { + "description": "the public MAC address for the router", + "name": "publicmacaddress", + "type": "string" + }, + { + "description": "the Pod ID for the router", + "name": "podid", + "type": "string" + }, + { + "description": "the account associated with the router", + "name": "account", + "type": "string" + }, + { + "description": "the id of the router", + "name": "id", + "type": "string" + }, + { + "description": "the version of template", + "name": "version", + "type": "string" + }, + { + "description": "the template name for the router", + "name": "templatename", + "type": "string" + }, + {}, + { + "description": "the Zone ID for the router", + "name": "zoneid", + "type": "string" + }, + { + "description": "the name of the router", + "name": "name", + "type": "string" + }, + { + "description": "if this router is an redundant virtual router", + "name": "isredundantrouter", + "type": "boolean" + }, + { + "description": "the state of redundant virtual router", + "name": "redundantstate", + "type": "string" + }, + { + "description": "the gateway for the router", + "name": "gateway", + "type": "string" + }, + { + "description": "the ID of the corresponding public network", + "name": "publicnetworkid", + "type": "string" + }, + { + "description": "role of the domain router", + "name": "role", + "type": "string" } ] }, @@ -48511,6 +49860,13 @@ "isasync": false, "name": "deleteLdapConfiguration", "params": [ + { + "description": "Hostname", + "length": 255, + "name": "hostname", + "required": true, + "type": "string" + }, { "description": "linked domain", "length": 255, @@ -48525,17 +49881,21 @@ "name": "port", "required": false, "type": "integer" - }, - { - "description": "Hostname", - "length": 255, - "name": "hostname", - "required": true, - "type": "string" } ], "related": "addLdapConfiguration", "response": [ + { + "description": "name of the host running the ldap server", + "name": "hostname", + "type": "string" + }, + {}, + { + "description": "linked domain", + "name": "domainid", + "type": "string" + }, {}, { "description": "port teh ldap server is running on", @@ -48551,17 +49911,6 @@ "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" - }, - { - "description": "name of the host running the ldap server", - "name": "hostname", - "type": "string" - }, - {}, - { - "description": "linked domain", - "name": "domainid", - "type": "string" } ], "since": "4.2.0" @@ -48572,44 +49921,36 @@ "name": "updateVolume", "params": [ { - "description": "The state of the volume", - "length": 255, - "name": "state", - "required": false, - "since": "4.3", - "type": "string" - }, - { - "description": "Destination storage pool UUID for the volume", + "description": "the ID of the disk volume", "length": 255, - "name": "storageid", - "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool", + "name": "id", + "related": "attachVolume,createVolume,updateVolume,listVolumes,migrateVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", "required": false, - "since": "4.3", "type": "uuid" }, { - "description": "The path of the volume", + "description": "The chain info of the volume", "length": 255, - "name": "path", + "name": "chaininfo", "required": false, + "since": "4.4", "type": "string" }, { - "description": "The chain info of the volume", + "description": "The path of the volume", "length": 255, - "name": "chaininfo", + "name": "path", "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", + "description": "Destination storage pool UUID for the volume", "length": 255, - "name": "customid", + "name": "storageid", + "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool", "required": false, - "since": "4.4", - "type": "string" + "since": "4.3", + "type": "uuid" }, { "description": "new name of the volume", @@ -48620,12 +49961,12 @@ "type": "string" }, { - "description": "the ID of the disk volume", + "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", "length": 255, - "name": "id", - "related": "attachVolume,createVolume,updateVolume,listVolumes,migrateVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", + "name": "customid", "required": false, - "type": "uuid" + "since": "4.4", + "type": "string" }, { "description": "an optional field, whether to the display the volume to the end user or not.", @@ -48633,88 +49974,112 @@ "name": "displayvolume", "required": false, "type": "boolean" + }, + { + "description": "The state of the volume", + "length": 255, + "name": "state", + "required": false, + "since": "4.3", + "type": "string" } ], "related": "attachVolume,createVolume,listVolumes,migrateVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", "response": [ { - "description": "the path of the volume", - "name": "path", + "description": "Hypervisor the volume belongs to", + "name": "hypervisor", "type": "string" }, + { + "description": "min iops of the disk volume", + "name": "miniops", + "type": "long" + }, { "description": "the display text of the disk offering", "name": "diskofferingdisplaytext", "type": "string" }, + {}, { - "description": "cluster id of the volume", - "name": "clusterid", + "description": "the disk utilization", + "name": "utilization", "type": "string" }, { - "description": "the state of the disk volume", - "name": "state", + "description": "IO requests write rate of the disk volume per the disk offering", + "name": "diskIopsWriteRate", + "type": "long" + }, + { + "description": "the project name of the vpn", + "name": "project", "type": "string" }, { - "description": "the status of the volume", - "name": "status", + "description": "name of the virtual machine", + "name": "vmname", "type": "string" }, { - "description": "true if the volume is extractable, false otherwise", - "name": "isextractable", + "description": "an optional field whether to the display the volume to the end user or not.", + "name": "displayvolume", "type": "boolean" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "the chain info of the volume", + "name": "chaininfo", "type": "string" }, { - "description": "true if storage snapshot is supported for the volume, false otherwise", - "name": "supportsstoragesnapshot", + "description": "true if the volume is extractable, false otherwise", + "name": "isextractable", "type": "boolean" }, { - "description": "the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached.", - "name": "deviceid", - "type": "long" + "description": "id of the virtual machine", + "name": "virtualmachineid", + "type": "string" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "cluster id of the volume", + "name": "clusterid", "type": "string" }, { - "description": "the project name of the vpn", - "name": "project", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { - "description": "ID of the snapshot from which this volume was created", - "name": "snapshotid", + "description": "the display text of the service offering for root disk", + "name": "serviceofferingdisplaytext", "type": "string" }, { - "description": "an optional field whether to the display the volume to the end user or not.", - "name": "displayvolume", - "type": "boolean" + "description": "type of the disk volume (ROOT or DATADISK)", + "name": "type", + "type": "string" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "the display text of the service offering for root disk", - "name": "serviceofferingdisplaytext", + "description": "ID of the disk offering", + "name": "diskofferingid", "type": "string" }, { - "description": "Hypervisor the volume belongs to", - "name": "hypervisor", + "description": "the project id of the vpn", + "name": "projectid", + "type": "string" + }, + { + "description": "state of the virtual machine", + "name": "vmstate", "type": "string" }, { @@ -48723,13 +50088,28 @@ "type": "string" }, { - "description": "ID of the service offering for root disk", - "name": "serviceofferingid", + "description": "name of the service offering for root disk", + "name": "serviceofferingname", "type": "string" }, { - "description": "shared or local storage", - "name": "storagetype", + "description": "pod id of the volume", + "name": "podid", + "type": "string" + }, + { + "description": "display name of the virtual machine", + "name": "vmdisplayname", + "type": "string" + }, + { + "description": "the date the disk volume was created", + "name": "created", + "type": "date" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -48738,113 +50118,170 @@ "type": "string" }, { - "description": "max iops of the disk volume", - "name": "maxiops", - "type": "long" + "description": "volume uuid that is given by virtualisation provider (only for VMware)", + "name": "externaluuid", + "type": "string" }, { - "description": "the boolean state of whether the volume is destroyed or not", - "name": "destroyed", + "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": "name of the disk volume", + "name": "name", "type": "string" }, { - "description": "ID of the availability zone", - "name": "zoneid", - "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 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" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + } + ], + "type": "set" }, { - "description": "the project id of the vpn", - "name": "projectid", + "description": "the domain associated with the disk volume", + "name": "domain", "type": "string" }, { - "description": "the account associated with the disk volume", - "name": "account", + "description": "the ID of the domain associated with the disk volume", + "name": "domainid", "type": "string" }, { - "description": "bytes write rate of the disk volume", - "name": "diskBytesWriteRate", + "description": "the write (IO) of disk on the vm", + "name": "diskiowrite", "type": "long" }, { - "description": "id of the virtual machine", - "name": "virtualmachineid", + "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": "ID of the disk volume", + "name": "id", "type": "string" }, { - "description": "pod name of the volume", - "name": "podname", - "type": "string" + "description": "true if storage snapshot is supported for the volume, false otherwise", + "name": "supportsstoragesnapshot", + "type": "boolean" }, { - "description": "pod id of the volume", - "name": "podid", + "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 service offering for root disk", + "name": "serviceofferingid", + "type": "string" }, { - "description": "min iops of the disk volume", - "name": "miniops", + "description": "IO requests read rate of the disk volume per the disk offering", + "name": "diskIopsReadRate", "type": "long" }, { - "description": "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": "type of the disk volume (ROOT or DATADISK)", - "name": "type", - "type": "string" + "description": "the date the volume was attached to a VM instance", + "name": "attached", + "type": "date" }, { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", - "type": "string" + "description": "max iops of the disk volume", + "name": "maxiops", + "type": "long" }, { - "description": "name of the disk offering", - "name": "diskofferingname", + "description": "the status of the volume", + "name": "status", "type": "string" }, { - "description": "the domain associated with the disk volume", - "name": "domain", + "description": "shared or local storage", + "name": "storagetype", "type": "string" }, { - "description": "the ID of the domain associated with the disk volume", - "name": "domainid", - "type": "string" + "description": "need quiesce vm or not when taking snapshot", + "name": "quiescevm", + "type": "boolean" }, { - "description": "display name of the virtual machine", - "name": "vmdisplayname", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "io requests read rate of the disk volume per the disk offering", - "name": "diskIopsReadRate", - "type": "long" + "description": "the boolean state of whether the volume is destroyed or not", + "name": "destroyed", + "type": "boolean" }, { - "description": "the write (bytes) of disk on the vm", - "name": "diskkbswrite", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", + "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" }, { @@ -48853,175 +50290,179 @@ "type": "long" }, { - "description": "the chain info of the volume", - "name": "chaininfo", + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" + }, + { + "description": "cluster name where the volume is allocated", + "name": "clustername", "type": "string" }, { - "description": "io requests write rate of the disk volume per the disk offering", - "name": "diskIopsWriteRate", - "type": "long" + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", + "type": "string" }, { - "description": "the read (io) of disk on the vm", - "name": "diskioread", + "description": "bytes read rate of the disk volume", + "name": "diskBytesReadRate", "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 path of the volume", + "name": "path", + "type": "string" + }, + { + "description": "the state of the disk volume", + "name": "state", + "type": "string" + }, { "description": "the bytes allocated", "name": "physicalsize", "type": "long" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "name of the disk offering", + "name": "diskofferingname", "type": "string" }, { - "description": "ID of the disk volume", - "name": "id", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, - {}, - { - "description": "the list of resource tags associated", - "name": "tags", - "response": [ - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - } - ], - "type": "set" - }, { "description": "provisioning type used to create volumes.", "name": "provisioningtype", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" }, { - "description": "name of the virtual machine", - "name": "vmname", + "description": "the account associated with the disk volume", + "name": "account", "type": "string" }, { - "description": "cluster name where the volume is allocated", - "name": "clustername", - "type": "string" + "description": "size of the disk volume", + "name": "size", + "type": "long" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "pod name of the volume", + "name": "podname", "type": "string" }, { - "description": "the write (io) of disk on the vm", - "name": "diskiowrite", + "description": "bytes write rate of the disk volume", + "name": "diskBytesWriteRate", "type": "long" }, { - "description": "the read (bytes) of disk on the vm", - "name": "diskkbsread", + "description": "the read (IO) of disk on the vm", + "name": "diskioread", "type": "long" + } + ] + }, + { + "description": "Lists traffic types of a given physical network.", + "isasync": false, + "name": "listTrafficTypes", + "params": [ + { + "description": "the Physical Network ID", + "length": 255, + "name": "physicalnetworkid", + "related": "createPhysicalNetwork", + "required": true, + "type": "uuid" }, { - "description": "state of the virtual machine", - "name": "vmstate", - "type": "string" + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "id of the primary storage hosting the disk volume; returned to admin user only", - "name": "storageid", + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + } + ], + "related": "listNetworkServiceProviders", + "response": [ + {}, + { + "description": "the destination physical network", + "name": "destinationphysicalnetworkid", "type": "string" }, { - "description": "bytes read rate of the disk volume", - "name": "diskBytesReadRate", - "type": "long" + "description": "state of the network provider", + "name": "state", + "type": "string" }, { - "description": "the date the disk volume was created", - "name": "created", - "type": "date" + "description": "true if individual services can be enabled/disabled", + "name": "canenableindividualservice", + "type": "boolean" }, { - "description": "name of the disk volume", - "name": "name", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the date the volume was attached to a VM instance", - "name": "attached", - "type": "date" + "description": "the provider name", + "name": "name", + "type": "string" }, { - "description": "the disk utilization", - "name": "utilization", + "description": "uuid of the network provider", + "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" }, { - "description": "need quiesce vm or not when taking snapshot", - "name": "quiescevm", - "type": "boolean" + "description": "the physical network this belongs to", + "name": "physicalnetworkid", + "type": "string" }, - {} - ] + {}, + { + "description": "services for this provider", + "name": "servicelist", + "type": "list" + } + ], + "since": "3.0.0" }, { "description": "Creates a Project role", @@ -49029,11 +50470,12 @@ "name": "createProjectRole", "params": [ { - "description": "The description of the Project role", + "description": "ID of project where role is being created", "length": 255, - "name": "description", - "required": false, - "type": "string" + "name": "projectid", + "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", + "required": true, + "type": "uuid" }, { "description": "creates a project role with this unique name", @@ -49043,137 +50485,279 @@ "type": "string" }, { - "description": "ID of project where role is being created", + "description": "The description of the Project role", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", - "required": true, - "type": "uuid" + "name": "description", + "required": false, + "type": "string" } ], "related": "updateProjectRole", "response": [ + { + "description": "the id of the project", + "name": "projectid", + "type": "string" + }, { "description": "the description of the role", "name": "description", "type": "string" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the name of the role", + "name": "name", + "type": "string" }, { - "description": "the id of the project", - "name": "projectid", + "description": "the ID of the role", + "name": "id", "type": "string" }, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "the ID of the role", - "name": "id", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, - { - "description": "the name of the role", - "name": "name", - "type": "string" - } + {}, + {} ], "since": "4.15.0" }, { - "description": "Lists traffic types of a given physical network.", - "isasync": false, - "name": "listTrafficTypes", + "description": "Creates an Ipv6 firewall rule in the given network (the network has to belong to VPC)", + "isasync": true, + "name": "createIpv6FirewallRule", "params": [ { - "description": "", + "description": "the protocol for the Ipv6 firewall rule. Valid values are TCP/UDP/ICMP/ALL or valid protocol number", "length": 255, - "name": "page", - "required": false, - "type": "integer" + "name": "protocol", + "required": true, + "type": "string" }, { - "description": "the Physical Network ID", + "description": "The network of the VM the Ipv6 firewall rule will be created for", "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork", + "name": "networkid", + "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listSrxFirewallNetworks,listBrocadeVcsDeviceNetworks", "required": true, "type": "uuid" }, { - "description": "", + "description": "the starting port of Ipv6 firewall rule", "length": 255, - "name": "pagesize", + "name": "startport", "required": false, "type": "integer" }, { - "description": "List by keyword", + "description": "type of the ICMP message being sent", "length": 255, - "name": "keyword", + "name": "icmptype", + "required": false, + "type": "integer" + }, + { + "description": "the source CIDR list to allow traffic from. Multiple entries must be separated by a single comma character (,).", + "length": 255, + "name": "cidrlist", + "required": false, + "type": "list" + }, + { + "description": "the destination CIDR list to allow traffic to. Multiple entries must be separated by a single comma character (,).", + "length": 255, + "name": "destcidrlist", + "required": false, + "type": "list" + }, + { + "description": "the traffic type for the Ipv6 firewall rule, can be ingress or egress, defaulted to ingress if not specified", + "length": 255, + "name": "traffictype", "required": false, "type": "string" + }, + { + "description": "the ending port of Ipv6 firewall rule", + "length": 255, + "name": "endport", + "required": false, + "type": "integer" + }, + { + "description": "error code for this ICMP message", + "length": 255, + "name": "icmpcode", + "required": false, + "type": "integer" + }, + { + "description": "an optional field, whether to the display the rule to the end user or not", + "length": 255, + "name": "fordisplay", + "required": false, + "type": "boolean" } ], - "related": "listNetworkServiceProviders", + "related": "updateIpv6FirewallRule,listPortForwardingRules,updatePortForwardingRule", "response": [ + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the VM ID for the port forwarding rule", + "name": "virtualmachineid", "type": "string" }, { - "description": "uuid of the network provider", - "name": "id", + "description": "the state of the rule", + "name": "state", "type": "string" }, { - "description": "the provider name", - "name": "name", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the starting port of port forwarding rule's public port range", + "name": "publicport", "type": "string" }, { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", + "description": "the public ip address for the port forwarding rule", + "name": "ipaddress", "type": "string" }, { - "description": "true if individual services can be enabled/disabled", - "name": "canenableindividualservice", - "type": "boolean" + "description": "the VM display name for the port forwarding rule", + "name": "virtualmachinedisplayname", + "type": "string" + }, + { + "description": "the public ip address id for the port forwarding rule", + "name": "ipaddressid", + "type": "string" + }, + { + "description": "the VM name for the port forwarding rule", + "name": "virtualmachinename", + "type": "string" + }, + { + "description": "the ending port of port forwarding rule's private port range", + "name": "publicendport", + "type": "string" + }, + { + "description": "the vm ip address for the port forwarding rule", + "name": "vmguestip", + "type": "string" }, - {}, {}, { - "description": "services for this provider", - "name": "servicelist", - "type": "list" + "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": "the destination physical network", - "name": "destinationphysicalnetworkid", + "description": "the ID of the port forwarding rule", + "name": "id", "type": "string" }, { - "description": "state of the network provider", - "name": "state", + "description": "the protocol of the port forwarding rule", + "name": "protocol", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the id of the guest network the port forwarding rule belongs to", + "name": "networkid", + "type": "string" + }, + { + "description": "the ending port of port forwarding rule's private port range", + "name": "privateendport", "type": "string" + }, + { + "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", + "type": "string" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "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": "the account associated with the tag", + "name": "account", + "type": "string" + } + ], + "type": "list" } - ], - "since": "3.0.0" + ] }, { "description": "Updates account information for the authenticated user", @@ -49181,17 +50765,17 @@ "name": "updateAccount", "params": [ { - "description": "Account UUID", + "description": "The UUID of the dynamic role to set for the account", "length": 255, - "name": "id", - "related": "createAccount,disableAccount,enableAccount,updateAccount,listAccounts,listAccounts", + "name": "roleid", + "related": "createRole,importRole,listRoles,updateRole", "required": false, "type": "uuid" }, { - "description": "Current account name", + "description": "Network domain for the account's networks; empty string will update domainName with NULL value", "length": 255, - "name": "account", + "name": "networkdomain", "required": false, "type": "string" }, @@ -49203,9 +50787,9 @@ "type": "string" }, { - "description": "Network domain for the account's networks; empty string will update domainName with NULL value", + "description": "Current account name", "length": 255, - "name": "networkdomain", + "name": "account", "required": false, "type": "string" }, @@ -49217,18 +50801,18 @@ "type": "map" }, { - "description": "The UUID of the dynamic role to set for the account", + "description": "The UUID of the domain where the account exists", "length": 255, - "name": "roleid", - "related": "createRole,importRole,listRoles,updateRole", + "name": "domainid", + "related": "listDomainChildren,listDomains,listDomains", "required": false, "type": "uuid" }, { - "description": "The UUID of the domain where the account exists", + "description": "Account UUID", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains,listDomains", + "name": "id", + "related": "createAccount,disableAccount,enableAccount,updateAccount,listAccounts,listAccounts", "required": false, "type": "uuid" } @@ -49236,48 +50820,34 @@ "related": "createAccount,disableAccount,enableAccount,listAccounts,listAccounts", "response": [ { - "description": "the total number of projects being administrated by this account", - "name": "projecttotal", - "type": "long" - }, - { - "description": "the total number of snapshots stored by this account", - "name": "snapshottotal", - "type": "long" - }, - { - "description": "the total number of projects the account can own", - "name": "projectlimit", + "description": "the total number of networks available to be created for this account", + "name": "networkavailable", "type": "string" }, { - "description": "path of the Domain the account belongs to", - "name": "domainpath", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, + {}, { - "description": "the id of the account", - "name": "id", + "description": "id of the Domain the account belongs to", + "name": "domainid", "type": "string" }, { - "description": "account type (admin, domain-admin, user)", - "name": "accounttype", - "type": "short" + "description": "the total secondary storage space (in GiB) available to be used for this account", + "name": "secondarystorageavailable", + "type": "string" }, { - "description": "the total number of cpu cores owned by account", - "name": "cputotal", + "description": "the total memory (in MB) owned by account", + "name": "memorytotal", "type": "long" }, { - "description": "the total number of networks the account can own", - "name": "networklimit", - "type": "string" - }, - { - "description": "the total secondary storage space (in GiB) the account can own", - "name": "secondarystoragelimit", + "description": "the total primary storage space (in GiB) the account can own", + "name": "primarystoragelimit", "type": "string" }, { @@ -49286,29 +50856,34 @@ "type": "long" }, { - "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 total number of public ip addresses this account can acquire", - "name": "iplimit", + "description": "the total number of cpu cores the account can own", + "name": "cpulimit", "type": "string" }, { - "description": "the total memory (in MB) available to be created for this account", - "name": "memoryavailable", - "type": "string" + "description": "the total number of cpu cores owned by account", + "name": "cputotal", + "type": "long" }, { - "description": "the total volume which can be used by this account", - "name": "volumelimit", - "type": "string" + "description": "the total number of virtual machines deployed by this account", + "name": "vmtotal", + "type": "long" }, { - "description": "the total secondary storage space (in GiB) available to be used for this account", - "name": "secondarystorageavailable", - "type": "string" + "description": "the total secondary storage space (in GiB) owned by account", + "name": "secondarystoragetotal", + "type": "float" + }, + { + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" }, { "description": "the total volume being used by this account", @@ -49316,78 +50891,48 @@ "type": "long" }, { - "description": "the total number of public ip addresses available for this account to acquire", - "name": "ipavailable", - "type": "string" + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" }, { - "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 primary storage space (in GiB) the account can own", - "name": "primarystoragelimit", + "description": "the total number of virtual machines available for this account to acquire", + "name": "vmavailable", "type": "string" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" - }, - { - "description": "the type of the role (Admin, ResourceAdmin, DomainAdmin, User)", - "name": "roletype", + "description": "the total number of public ip addresses this account can acquire", + "name": "iplimit", "type": "string" }, { - "description": "the total number of virtual machines running for this account", - "name": "vmrunning", - "type": "integer" - }, - { - "description": "the total number of templates available to be created by this account", - "name": "templateavailable", + "description": "the total number of templates which can be created by this account", + "name": "templatelimit", "type": "string" }, { - "description": "the total number of projects available for administration by this account", - "name": "projectavailable", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "the list of users associated with account", "name": "user", "response": [ - { - "description": "the user ID", - "name": "id", - "type": "string" - }, - { - "description": "the ID of the role", - "name": "roleid", - "type": "string" - }, - { - "description": "the user lastname", - "name": "lastname", - "type": "string" - }, - { - "description": "the timezone user was created in", - "name": "timezone", - "type": "string" - }, { "description": "the user name", "name": "username", "type": "string" }, { - "description": "the user firstname", - "name": "firstname", - "type": "string" + "description": "true if user is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { "description": "the api key of the user", @@ -49395,24 +50940,24 @@ "type": "string" }, { - "description": "the account ID of the user", - "name": "accountid", + "description": "the user firstname", + "name": "firstname", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the date and time the user account was created", + "name": "created", + "type": "date" }, { - "description": "the domain name of the user", - "name": "domain", + "description": "the user ID", + "name": "id", "type": "string" }, { - "description": "the date and time the user account was created", - "name": "created", - "type": "date" + "description": "the name of the role", + "name": "rolename", + "type": "string" }, { "description": "the boolean value representing if the updating target is in caller's child domain", @@ -49420,13 +50965,13 @@ "type": "boolean" }, { - "description": "the account name of the user", - "name": "account", - "type": "string" + "description": "the account type of the user", + "name": "accounttype", + "type": "integer" }, { - "description": "the name of the role", - "name": "rolename", + "description": "the account name of the user", + "name": "account", "type": "string" }, { @@ -49440,19 +50985,24 @@ "type": "string" }, { - "description": "the user email address", - "name": "email", + "description": "the user state", + "name": "state", "type": "string" }, { - "description": "the secret key of the user", - "name": "secretkey", + "description": "the account ID of the user", + "name": "accountid", "type": "string" }, { - "description": "true if user is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the secret key of the user", + "name": "secretkey", + "type": "string" }, { "description": "the source type of the user in lowercase, such as native, ldap, saml2", @@ -49460,56 +51010,61 @@ "type": "string" }, { - "description": "the user state", - "name": "state", + "description": "the user lastname", + "name": "lastname", "type": "string" }, { - "description": "the account type of the user", - "name": "accounttype", - "type": "short" + "description": "the user email address", + "name": "email", + "type": "string" + }, + { + "description": "the ID of the role", + "name": "roleid", + "type": "string" + }, + { + "description": "the domain name of the user", + "name": "domain", + "type": "string" + }, + { + "description": "the timezone user was created in", + "name": "timezone", + "type": "string" } ], "type": "list" }, { - "description": "the total number of snapshots which can be stored by this account", - "name": "snapshotlimit", - "type": "string" - }, - { - "description": "the total number of virtual machines stopped for this account", - "name": "vmstopped", - "type": "integer" - }, - { - "description": "the default zone of the account", - "name": "defaultzoneid", + "description": "the total number of public ip addresses available for this account to acquire", + "name": "ipavailable", "type": "string" }, { - "description": "the name of the account", - "name": "name", + "description": "the total number of vpcs available to be created for this account", + "name": "vpcavailable", "type": "string" }, { - "description": "the network domain", - "name": "networkdomain", - "type": "string" + "description": "account type (admin, domain-admin, user)", + "name": "accounttype", + "type": "integer" }, { - "description": "the total number of vpcs available to be created for this account", - "name": "vpcavailable", + "description": "the total number of virtual machines that can be deployed by this account", + "name": "vmlimit", "type": "string" }, - { - "description": "the total number of vpcs the account can own", - "name": "vpclimit", - "type": "string" + { + "description": "true if the account requires cleanup", + "name": "iscleanuprequired", + "type": "boolean" }, { - "description": "the total number of networks available to be created for this account", - "name": "networkavailable", + "description": "the total volume available for this account", + "name": "volumeavailable", "type": "string" }, { @@ -49518,141 +51073,170 @@ "type": "long" }, { - "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 total memory (in MB) the account can own", - "name": "memorylimit", + "description": "the total number of vpcs owned by account", + "name": "vpctotal", + "type": "long" + }, + { + "description": "the list of acl groups that account belongs to", + "name": "groups", + "type": "list" + }, + { + "description": "the total memory (in MB) available to be created for this account", + "name": "memoryavailable", "type": "string" }, { - "description": "the total number of virtual machines that can be deployed by this account", - "name": "vmlimit", + "description": "details for the account", + "name": "accountdetails", + "type": "map" + }, + { + "description": "the total number of cpu cores available to be created for this account", + "name": "cpuavailable", "type": "string" }, { - "description": "the total number of cpu cores the account can own", - "name": "cpulimit", + "description": "the total number of networks the account can own", + "name": "networklimit", "type": "string" }, + {}, { - "description": "the total primary storage space (in GiB) available to be used for this account", - "name": "primarystorageavailable", + "description": "the type of the role (Admin, ResourceAdmin, DomainAdmin, User)", + "name": "roletype", "type": "string" }, { - "description": "name of the Domain the account belongs to", - "name": "domain", + "description": "the total number of virtual machines running for this account", + "name": "vmrunning", + "type": "integer" + }, + { + "description": "the state of the account", + "name": "state", "type": "string" }, { - "description": "details for the account", - "name": "accountdetails", - "type": "map" + "description": "the name of the role", + "name": "rolename", + "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "the total number of virtual machines stopped for this account", + "name": "vmstopped", "type": "integer" }, { - "description": "the total number of templates which can be created by this account", - "name": "templatelimit", + "description": "path of the Domain the account belongs to", + "name": "domainpath", "type": "string" }, { - "description": "true if the account requires cleanup", - "name": "iscleanuprequired", + "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 virtual machines available for this account to acquire", - "name": "vmavailable", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the total number of snapshots available for this account", - "name": "snapshotavailable", + "description": "the network domain", + "name": "networkdomain", "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", + "description": "the total memory (in MB) the account can own", + "name": "memorylimit", + "type": "string" + }, + { + "description": "the total number of snapshots stored by this account", + "name": "snapshottotal", "type": "long" }, - {}, - {}, { - "description": "the total number of cpu cores available to be created for this account", - "name": "cpuavailable", + "description": "the total secondary storage space (in GiB) the account can own", + "name": "secondarystoragelimit", "type": "string" }, { - "description": "the state of the account", - "name": "state", - "type": "string" + "description": "the total number of networks owned by account", + "name": "networktotal", + "type": "long" }, { - "description": "the total volume available for this account", - "name": "volumeavailable", + "description": "the default zone of the account", + "name": "defaultzoneid", "type": "string" }, { - "description": "true if account is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "the total number of snapshots which can be stored by this account", + "name": "snapshotlimit", + "type": "string" }, { - "description": "the total memory (in MB) owned by account", - "name": "memorytotal", + "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 total number of projects available for administration by this account", + "name": "projectavailable", + "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the total number of projects the account can own", + "name": "projectlimit", + "type": "string" }, { - "description": "the name of the role", - "name": "rolename", + "description": "the total primary storage space (in GiB) available to be used for this account", + "name": "primarystorageavailable", "type": "string" }, { - "description": "the total number of virtual machines deployed by this account", - "name": "vmtotal", - "type": "long" + "description": "the total number of snapshots available for this account", + "name": "snapshotavailable", + "type": "string" }, { - "description": "the list of acl groups that account belongs to", - "name": "groups", - "type": "list" + "description": "the total number of vpcs the account can own", + "name": "vpclimit", + "type": "string" }, { - "description": "the ID of the role", - "name": "roleid", + "description": "the name of the account", + "name": "name", "type": "string" }, { - "description": "the total number of vpcs owned by account", - "name": "vpctotal", - "type": "long" + "description": "name of the Domain the account belongs to", + "name": "domain", + "type": "string" }, { - "description": "the date when this account was created", - "name": "created", - "type": "date" + "description": "the id of the account", + "name": "id", + "type": "string" }, { - "description": "the total number of networks owned by account", - "name": "networktotal", - "type": "long" + "description": "the total volume which can be used by this account", + "name": "volumelimit", + "type": "string" } ] }, @@ -49661,6 +51245,13 @@ "isasync": false, "name": "addSecondaryStorage", "params": [ + { + "description": "the URL for the secondary storage", + "length": 255, + "name": "url", + "required": true, + "type": "string" + }, { "description": "the Zone ID for the secondary storage", "length": 255, @@ -49668,36 +51259,24 @@ "related": "createZone,updateZone,listZones,listZones", "required": false, "type": "uuid" - }, - { - "description": "the URL for the secondary storage", - "length": 255, - "name": "url", - "required": true, - "type": "string" } ], "related": "listSwifts,addImageStoreS3,listImageStores,updateCloudToUseObjectStore", "response": [ {}, { - "description": "the 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": "defines if store is read-only", + "name": "readonly", + "type": "boolean" }, { - "description": "the url of the image store", - "name": "url", - "type": "string" + "description": "the scope of the image store", + "name": "scope", + "type": "scopetype" }, { - "description": "the Zone ID of the image store", - "name": "zoneid", + "description": "the ID of the image store", + "name": "id", "type": "string" }, { @@ -49706,45 +51285,50 @@ "type": "string" }, { - "description": "the scope of the image store", - "name": "scope", - "type": "scopetype" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "the provider name of the image store", "name": "providername", "type": "string" }, + {}, { - "description": "defines if store is read-only", - "name": "readonly", - "type": "boolean" + "description": "the total disk size of the host", + "name": "disksizetotal", + "type": "long" + }, + { + "description": "the url of the image store", + "name": "url", + "type": "string" }, { "description": "the host's currently used disk size", "name": "disksizeused", "type": "long" }, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the ID of the image store", - "name": "id", + "description": "the Zone ID of the image store", + "name": "zoneid", "type": "string" }, { - "description": "the total disk size of the host", - "name": "disksizetotal", - "type": "long" + "description": "the protocol of the image store", + "name": "protocol", + "type": "string" }, { "description": "the Zone name of the image store", @@ -49765,6 +51349,13 @@ "required": false, "type": "boolean" }, + { + "description": "DHCP options which are passed to the VM on start up Example: dhcpoptionsnetworklist[0].dhcp:114=url&dhcpoptionsetworklist[0].networkid=networkid&dhcpoptionsetworklist[0].dhcp:66=www.test.com", + "length": 255, + "name": "dhcpoptionsnetworklist", + "required": false, + "type": "map" + }, { "description": "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, @@ -49773,20 +51364,36 @@ "type": "boolean" }, { - "description": "The ID of the virtual machine", - "length": 255, - "name": "id", - "related": "migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,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": "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": "DHCP options which are passed to the VM on start up Example: dhcpoptionsnetworklist[0].dhcp:114=url&dhcpoptionsetworklist[0].networkid=networkid&dhcpoptionsetworklist[0].dhcp:66=www.test.com", + "description": "Details in key/value pairs. 'extraconfig' is not allowed to be passed in details.", "length": 255, - "name": "dhcpoptionsnetworklist", + "name": "details", "required": false, "type": "map" }, + { + "description": "an optional binary data that can be sent to the virtual machine upon a successful deployment. This binary data must be base64 encoded before adding it to the request. Using HTTP GET (via querystring), you can send up to 4KB of data after base64 encoding. Using HTTP POST(via POST body), you can send up to 1MB of data after base64 encoding.You also need to change vm.userdata.max.length value", + "length": 1048576, + "name": "userdata", + "required": false, + "since": "4.16.0", + "type": "string" + }, + { + "description": "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": "list of security group ids to be applied on the virtual machine.", "length": 255, @@ -49803,36 +51410,20 @@ "type": "string" }, { - "description": "instance name of the user vm", + "description": "group of the virtual machine", "length": 255, - "name": "instancename", + "name": "group", "required": false, - "since": "4.4", "type": "string" }, { - "description": "new host name of the vm. The VM has to be stopped/started for this update to take affect", + "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": "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": "group of the virtual machine", - "length": 255, - "name": "group", - "required": false, - "type": "string" - }, { "description": "optional boolean field, which indicates if details should be cleaned up or not (if set to true, details removed for this resource, details field ignored; if false or not set, no action)", "length": 255, @@ -49841,21 +51432,13 @@ "type": "boolean" }, { - "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", + "description": "instance name of the user vm", "length": 255, - "name": "customid", + "name": "instancename", "required": false, "since": "4.4", "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", - "type": "string" - }, { "description": "true if high-availability is enabled for the virtual machine, false otherwise", "length": 255, @@ -49864,34 +51447,122 @@ "type": "boolean" }, { - "description": "Details in key/value pairs. 'extraconfig' is not allowed to be passed in details.", + "description": "the ID of the OS type that best represents this VM.", "length": 255, - "name": "details", + "name": "ostypeid", + "related": "listOsTypes,addGuestOs", "required": false, - "type": "map" + "type": "uuid" }, { - "description": "comma separated list of security groups names that going to be applied to the virtual machine. Should be passed only when vm is created from a zone with Basic Network support. Mutually exclusive with securitygroupids parameter", + "description": "new host name of the vm. The VM has to be stopped/started for this update to take affect", "length": 255, - "name": "securitygroupnames", - "related": "createSecurityGroup", + "name": "name", "required": false, - "type": "list" + "since": "4.4", + "type": "string" }, { - "description": "the ID of the OS type that best represents this VM.", + "description": "The ID of the virtual machine", "length": 255, - "name": "ostypeid", - "related": "listOsTypes,addGuestOs", - "required": false, + "name": "id", + "related": "migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance", + "required": true, "type": "uuid" } ], "related": "migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,startVirtualMachine,stopVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance", "response": [ { - "description": "the write (io) of disk on the vm", - "name": "diskiowrite", + "description": "device type of the root volume", + "name": "rootdevicetype", + "type": "string" + }, + { + "description": "the ID of the availablility zone for the virtual machine", + "name": "zoneid", + "type": "string" + }, + { + "description": "the state of the virtual machine", + "name": "state", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the name of the virtual machine", + "name": "name", + "type": "string" + }, + { + "description": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", + "response": [ + { + "description": "the ID of the affinity group", + "name": "id", + "type": "string" + }, + { + "description": "the description of the affinity group", + "name": "description", + "type": "string" + }, + { + "description": "the domain ID of the affinity group", + "name": "domainid", + "type": "string" + }, + { + "description": "the name of the affinity group", + "name": "name", + "type": "string" + }, + { + "description": "the account owning the affinity group", + "name": "account", + "type": "string" + }, + { + "description": "the project name of the affinity group", + "name": "project", + "type": "string" + }, + { + "description": "the project ID of the affinity group", + "name": "projectid", + "type": "string" + }, + { + "description": "the domain name of the affinity group", + "name": "domain", + "type": "string" + }, + { + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" + }, + { + "description": "the type of the affinity group", + "name": "type", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" + }, + { + "description": "the read (IO) of disk on the VM", + "name": "diskioread", "type": "long" }, { @@ -49900,18 +51571,18 @@ "type": "string" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "the ID of the virtual machine", + "name": "id", "type": "string" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "OS name of the vm", + "name": "osdisplayname", "type": "string" }, { - "description": "the project name of the vm", - "name": "project", + "description": "the name of the disk offering of the virtual machine", + "name": "diskofferingname", "type": "string" }, { @@ -49925,39 +51596,79 @@ "type": "string" }, { - "description": "ssh key-pair", - "name": "keypair", - "type": "string" + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" }, + {}, { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, - {}, { - "description": "the name of the disk offering of the virtual machine", - "name": "diskofferingname", + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the project id of the vm", + "name": "projectid", "type": "string" }, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", + "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 name of the availability zone for the virtual machine", "name": "zonename", "type": "string" }, { - "description": "the pool type of the virtual machine", - "name": "pooltype", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the ID of the host for the virtual machine", + "name": "hostid", "type": "string" }, { - "description": "the ID of the disk offering of the virtual machine", - "name": "diskofferingid", + "description": "the password (if exists) of the virtual machine", + "name": "password", + "type": "string" + }, + { + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" + }, + { + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", + "type": "string" + }, + { + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", + "type": "string" + }, + { + "description": "the account associated with the virtual machine", + "name": "account", + "type": "string" + }, + { + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", "type": "string" }, { @@ -49965,18 +51676,23 @@ "name": "tags", "response": [ { - "description": "the project name where tag belongs to", - "name": "project", + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "tag value", + "name": "value", "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": "the domain associated with the tag", + "name": "domain", "type": "string" }, { @@ -49985,8 +51701,8 @@ "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { @@ -49995,207 +51711,137 @@ "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "id of the resource", + "name": "resourceid", "type": "string" } ], "type": "set" }, - { - "description": "the read (io) of disk on the vm", - "name": "diskioread", - "type": "long" - }, - { - "description": "the project id of the vm", - "name": "projectid", - "type": "string" - }, + {}, { "description": " an alternate display text of the template for the virtual machine", "name": "templatedisplaytext", "type": "string" }, { - "description": "Guest vm Boot Type", - "name": "boottype", + "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": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the group name of the virtual machine", - "name": "group", + "description": "the user's ID who deployed the virtual machine", + "name": "userid", "type": "string" }, { - "description": "the group ID of the virtual machine", - "name": "groupid", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" - }, - { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" + "description": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" }, { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", + "description": "the name of the host for the virtual machine", + "name": "hostname", "type": "string" }, { - "description": "State of the Service from LB rule", - "name": "servicestate", + "description": "Guest vm Boot Type", + "name": "boottype", "type": "string" }, { - "description": "the ID of the virtual machine", - "name": "id", + "description": "the group name of the virtual machine", + "name": "group", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the group ID of the virtual machine", + "name": "groupid", "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", + "description": "the project name of the vm", + "name": "project", "type": "string" }, { - "description": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", - "response": [ - { - "description": "the project name of the affinity group", - "name": "project", - "type": "string" - }, - { - "description": "the domain ID of the affinity group", - "name": "domainid", - "type": "string" - }, - { - "description": "the account owning the affinity group", - "name": "account", - "type": "string" - }, - { - "description": "the domain name of the affinity group", - "name": "domain", - "type": "string" - }, - { - "description": "the name of the affinity group", - "name": "name", - "type": "string" - }, - { - "description": "the type of the affinity group", - "name": "type", - "type": "string" - }, - { - "description": "the project ID of the affinity group", - "name": "projectid", - "type": "string" - }, - { - "description": "the ID of the affinity group", - "name": "id", - "type": "string" - }, - { - "description": "the description of the affinity group", - "name": "description", - "type": "string" - }, - { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" - } - ], - "type": "set" + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, + { + "description": "the 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": "device type of the root volume", - "name": "rootdevicetype", - "type": "string" + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", + "type": "string" }, { - "description": "the user's name who deployed the virtual machine", - "name": "username", + "description": "Os type ID of the virtual machine", + "name": "guestosid", "type": "string" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", "type": "long" }, + {}, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", "type": "boolean" }, - { - "description": "the ID of the availablility zone for the virtual machine", - "name": "zoneid", - "type": "string" - }, { "description": "list of security groups associated with the virtual machine", "name": "securitygroup", "response": [ { - "description": "the domain ID of the security group", - "name": "domainid", + "description": "the ID of the security group", + "name": "id", "type": "string" }, { @@ -50203,99 +51849,109 @@ "name": "tags", "response": [ { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "customer associated with the tag", + "name": "customer", "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": "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": "resource type", - "name": "resourcetype", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "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 project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "tag key name", + "name": "key", "type": "string" } ], "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", + "description": "the list of egress rules associated with the security group", + "name": "egressrule", "response": [ - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, { "description": "the starting IP of the security group rule", "name": "startport", "type": "integer" }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, { "description": "the ending IP of the security group rule ", "name": "endport", "type": "integer" }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "account owning the security group rule", + "name": "account", + "type": "string" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ - { - "description": "the 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", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { @@ -50314,13 +51970,18 @@ "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { @@ -50329,90 +51990,60 @@ "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" } ], "type": "set" }, { - "description": "the type of the ICMP message response", - "name": "icmptype", + "description": "the code for the ICMP message response", + "name": "icmpcode", "type": "integer" }, - { - "description": "account owning the security group rule", - "name": "account", - "type": "string" - }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, { "description": "the id of the security group rule", "name": "ruleid", "type": "string" - }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" } ], "type": "set" }, { - "description": "the project name of the group", - "name": "project", - "type": "string" - }, - { - "description": "the domain name of the security group", - "name": "domain", - "type": "string" - }, - { - "description": "the ID of the security group", - "name": "id", - "type": "string" - }, - { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" - }, - { - "description": "the name of the security group", - "name": "name", + "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 project id of the group", - "name": "projectid", + "description": "the project name of the group", + "name": "project", "type": "string" }, { - "description": "the description of the security group", - "name": "description", + "description": "the domain ID of the security group", + "name": "domainid", "type": "string" }, { - "description": "the list of 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": "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", @@ -50433,38 +52064,28 @@ "name": "protocol", "type": "string" }, - { - "description": "account owning the security group rule", - "name": "account", - "type": "string" - }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "id of the resource", - "name": "resourceid", + "description": "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": "customer associated with the tag", - "name": "customer", + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { @@ -50478,193 +52099,171 @@ "type": "string" }, { - "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": "tag value", + "name": "value", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "tag value", - "name": "value", + "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 type of the ICMP message response", "name": "icmptype", "type": "integer" + }, + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" } ], "type": "set" - } - ], - "type": "set" - }, - { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", - "type": "boolean" - }, - { - "description": "the write (bytes) of disk on the vm", - "name": "diskkbswrite", - "type": "long" - }, - { - "description": "the internal memory that's free in vm or zero if it can not be calculated", - "name": "memoryintfreekbs", - "type": "long" - }, - { - "description": "the vgpu type used by the virtual machine", - "name": "vgpu", - "type": "string" - }, - { - "description": "the ID of the host for the virtual machine", - "name": "hostid", - "type": "string" - }, - { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" - }, - { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", - "type": "string" - }, - { - "description": "the read (bytes) of disk on the vm", - "name": "diskkbsread", - "type": "long" - }, - { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" - }, - {}, - { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", - "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 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" + }, + { + "description": "the description of the security group", + "name": "description", + "type": "string" + } + ], + "type": "set" }, { - "description": "the name of the host for the virtual machine", - "name": "hostname", + "description": "OS type id of the vm", + "name": "ostypeid", "type": "string" }, { - "description": "OS name of the vm", - "name": "osdisplayname", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", "type": "string" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", "type": "string" }, { - "description": "the memory used by the vm", - "name": "memorykbs", + "description": "the VM's disk read in KiB", + "name": "diskkbsread", "type": "long" }, { - "description": "OS type id of the vm", - "name": "ostypeid", - "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": "the target memory in vm", + "description": "the target memory in VM (KiB)", "name": "memorytargetkbs", "type": "long" }, { - "description": "the speed of each cpu", - "name": "cpuspeed", - "type": "integer" + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", + "type": "boolean" }, { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", + "description": "ssh key-pairs", + "name": "keypairs", "type": "string" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", - "type": "string" + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", "type": "boolean" }, { - "description": "the name of the virtual machine", - "name": "name", + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" + }, + { + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" + }, + { + "description": "the ID of the disk offering of the virtual machine", + "name": "diskofferingid", "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 VLAN/VNI if available", "name": "vlanid", "type": "integer" }, { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", - "type": "string" - }, - { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "the type of the nic", + "name": "type", "type": "string" }, { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "description": "the ip address of the nic", + "name": "ipaddress", "type": "string" }, { @@ -50673,33 +52272,28 @@ "type": "string" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "the gateway of the nic", + "name": "gateway", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "the IPv6 address of network", + "name": "ip6address", "type": "string" }, { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", + "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 type of the nic", - "name": "type", + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", "type": "string" }, { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", "type": "string" }, { @@ -50708,14 +52302,14 @@ "type": "boolean" }, { - "description": "the IPv6 address of network", - "name": "ip6address", + "description": "the netmask of the nic", + "name": "netmask", "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": "IP addresses associated with NIC found for unmanaged VM", @@ -50723,18 +52317,18 @@ "type": "list" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "the gateway of the nic", - "name": "gateway", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { @@ -50743,102 +52337,102 @@ "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "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", + "description": "the ID of the corresponding network", + "name": "networkid", "type": "string" }, { - "description": "the traffic type of the nic", - "name": "traffictype", + "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 Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" }, { - "description": "the netmask of the nic", - "name": "netmask", + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "type": "string" }, { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", "type": "string" }, { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", + "description": "the 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 type if available", + "name": "isolatedpvlantype", "type": "string" } ], "type": "set" }, { - "description": "the state of the virtual machine", - "name": "state", + "description": "the pool type of the virtual machine", + "name": "pooltype", "type": "string" }, { - "description": "the number of cpu this virtual machine is running with", - "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 write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", - "type": "string" + "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", + "type": "long" }, { - "description": "the account associated with the virtual machine", - "name": "account", + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", "type": "string" }, { - "description": "the incoming network traffic on the vm", - "name": "networkkbsread", - "type": "long" - }, - { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "Guest vm Boot Mode", + "name": "bootmode", "type": "string" }, { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", "type": "string" }, { - "description": "the outgoing network traffic on the host", - "name": "networkkbswrite", + "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 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": "publicipid", + "type": "string" }, { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" + "description": "the user's name who deployed the virtual machine", + "name": "username", + "type": "string" } ] }, @@ -50881,55 +52475,14 @@ "related": "createAccount,enableAccount,listAccounts,listAccounts", "response": [ { - "description": "the total number of public ip addresses available for this account to acquire", - "name": "ipavailable", - "type": "string" - }, - { - "description": "the total volume available for this account", - "name": "volumeavailable", - "type": "string" - }, - { - "description": "the type of the role (Admin, ResourceAdmin, DomainAdmin, User)", - "name": "roletype", - "type": "string" - }, - { - "description": "the list of acl groups that account belongs to", - "name": "groups", - "type": "list" - }, - { - "description": "the total number of templates which can be created by this account", - "name": "templatelimit", - "type": "string" - }, - { - "description": "the ID of the role", - "name": "roleid", - "type": "string" - }, - { - "description": "the total number of cpu cores the account can own", - "name": "cpulimit", - "type": "string" - }, - { - "description": "the total secondary storage space (in GiB) the account can own", - "name": "secondarystoragelimit", + "description": "the name of the role", + "name": "rolename", "type": "string" }, { - "description": "the total number of virtual machines running for this account", - "name": "vmrunning", - "type": "integer" - }, - {}, - { - "description": "the total number of snapshots which can be stored by this account", - "name": "snapshotlimit", - "type": "string" + "description": "the total number of cpu cores owned by account", + "name": "cputotal", + "type": "long" }, { "description": "the total number of projects being administrated by this account", @@ -50937,54 +52490,55 @@ "type": "long" }, { - "description": "the total number of public ip addresses allocated for this account", - "name": "iptotal", - "type": "long" + "description": "the total number of public ip addresses this account can acquire", + "name": "iplimit", + "type": "string" }, { - "description": "the total number of virtual machines stopped for this account", - "name": "vmstopped", - "type": "integer" + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" }, { - "description": "the total number of networks the account can own", - "name": "networklimit", - "type": "string" + "description": "the total memory (in MB) owned by account", + "name": "memorytotal", + "type": "long" }, { - "description": "the total number of snapshots available for this account", - "name": "snapshotavailable", + "description": "id of the Domain the account belongs to", + "name": "domainid", "type": "string" }, { - "description": "the total number of vpcs available to be created for this account", - "name": "vpcavailable", + "description": "the total number of networks available to be created for this account", + "name": "networkavailable", "type": "string" }, + {}, { "description": "the network domain", "name": "networkdomain", "type": "string" }, { - "description": "the total number of cpu cores available to be created for this account", - "name": "cpuavailable", + "description": "the total number of templates available to be created by this account", + "name": "templateavailable", "type": "string" }, { - "description": "the total number of networks owned by account", - "name": "networktotal", - "type": "long" + "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 primary storage space (in GiB) available to be used for this account", + "name": "primarystorageavailable", + "type": "string" }, { - "description": "the total number of networks available to be created for this account", - "name": "networkavailable", - "type": "string" + "description": "account type (admin, domain-admin, user)", + "name": "accounttype", + "type": "integer" }, { "description": "path of the Domain the account belongs to", @@ -50992,88 +52546,58 @@ "type": "string" }, { - "description": "the name of the role", - "name": "rolename", - "type": "string" - }, - { - "description": "the total number of projects the account can own", - "name": "projectlimit", - "type": "string" - }, - { - "description": "the total number of virtual machines available for this account to acquire", - "name": "vmavailable", - "type": "string" - }, - { - "description": "the state of the account", - "name": "state", + "description": "the total memory (in MB) the account can own", + "name": "memorylimit", "type": "string" }, { - "description": "the total memory (in MB) owned by account", - "name": "memorytotal", - "type": "long" + "description": "the total number of virtual machines stopped for this account", + "name": "vmstopped", + "type": "integer" }, { - "description": "the id of the account", - "name": "id", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the total number of vpcs the account can own", - "name": "vpclimit", + "description": "the name of the account", + "name": "name", "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", + "description": "the total number of vpcs owned by account", + "name": "vpctotal", "type": "long" }, { - "description": "the total memory (in MB) the account can own", - "name": "memorylimit", - "type": "string" - }, - { - "description": "the default zone of the account", - "name": "defaultzoneid", + "description": "the type of the role (Admin, ResourceAdmin, DomainAdmin, User)", + "name": "roletype", "type": "string" }, { - "description": "the total primary storage space (in GiB) available to be used for this account", - "name": "primarystorageavailable", + "description": "the total primary storage space (in GiB) the account can own", + "name": "primarystoragelimit", "type": "string" }, { - "description": "the total primary storage space (in GiB) owned by account", - "name": "primarystoragetotal", - "type": "long" - }, - { - "description": "the total number of cpu cores owned by account", - "name": "cputotal", + "description": "the total number of public ip addresses allocated for this account", + "name": "iptotal", "type": "long" }, { - "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", + "description": "the total number of networks the account can own", + "name": "networklimit", "type": "string" }, { - "description": "the name of the account", - "name": "name", - "type": "string" + "description": "true if the account requires cleanup", + "name": "iscleanuprequired", + "type": "boolean" }, { - "description": "the total number of public ip addresses this account can acquire", - "name": "iplimit", + "description": "the id of the account", + "name": "id", "type": "string" }, { @@ -51082,73 +52606,77 @@ "type": "boolean" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", + "description": "the total number of networks owned by account", + "name": "networktotal", "type": "long" }, { - "description": "the total secondary storage space (in GiB) available to be used for this account", - "name": "secondarystorageavailable", - "type": "string" + "description": "the total secondary storage space (in GiB) owned by account", + "name": "secondarystoragetotal", + "type": "float" }, - {}, { "description": "the total number of virtual machines deployed by this account", "name": "vmtotal", "type": "long" }, { - "description": "name of the Domain the account belongs to", - "name": "domain", - "type": "string" + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" }, { - "description": "the total number of snapshots stored by this account", - "name": "snapshottotal", + "description": "the total volume being used by this account", + "name": "volumetotal", "type": "long" }, { - "description": "details for the account", - "name": "accountdetails", - "type": "map" + "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 total number of virtual machines running for this account", + "name": "vmrunning", "type": "integer" }, { - "description": "account type (admin, domain-admin, user)", - "name": "accounttype", - "type": "short" - }, - { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the total number of projects the account can own", + "name": "projectlimit", + "type": "string" }, { - "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 secondary storage space (in GiB) owned by account", - "name": "secondarystoragetotal", - "type": "float" + "description": "the total number of templates which can be created by this account", + "name": "templatelimit", + "type": "string" }, { "description": "the list of users associated with account", "name": "user", "response": [ { - "description": "the user name", - "name": "username", + "description": "the date and time the user account was created", + "name": "created", + "type": "date" + }, + { + "description": "the user state", + "name": "state", "type": "string" }, { - "description": "the domain ID of the user", - "name": "domainid", + "description": "true if user is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "the account name of the user", + "name": "account", "type": "string" }, { @@ -51157,23 +52685,23 @@ "type": "string" }, { - "description": "the user ID", - "name": "id", + "description": "the user firstname", + "name": "firstname", "type": "string" }, { - "description": "the domain name of the user", - "name": "domain", - "type": "string" + "description": "the boolean value representing if the updating target is in caller's child domain", + "name": "iscallerchilddomain", + "type": "boolean" }, { - "description": "the user lastname", - "name": "lastname", + "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", + "description": "the domain name of the user", + "name": "domain", "type": "string" }, { @@ -51182,48 +52710,38 @@ "type": "string" }, { - "description": "the user firstname", - "name": "firstname", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the user state", - "name": "state", + "description": "the source type of the user in lowercase, such as native, ldap, saml2", + "name": "usersource", "type": "string" }, { - "description": "the api key of the user", - "name": "apikey", + "description": "the domain ID of the user", + "name": "domainid", "type": "string" }, { - "description": "the account name of the user", - "name": "account", + "description": "the type of the role", + "name": "roletype", "type": "string" }, { "description": "the account type of the user", "name": "accounttype", - "type": "short" + "type": "integer" }, { - "description": "the account ID of the user", - "name": "accountid", + "description": "the name of the role", + "name": "rolename", "type": "string" }, { - "description": "the boolean value representing if the updating target is in caller's child domain", - "name": "iscallerchilddomain", - "type": "boolean" - }, - { - "description": "the date and time the user account was created", - "name": "created", - "type": "date" - }, - { - "description": "the name of the role", - "name": "rolename", + "description": "the user ID", + "name": "id", "type": "string" }, { @@ -51232,42 +52750,52 @@ "type": "string" }, { - "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 email address", - "name": "email", + "description": "the api key of the user", + "name": "apikey", "type": "string" }, { - "description": "the type of the role", - "name": "roletype", + "description": "the user name", + "name": "username", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the user lastname", + "name": "lastname", + "type": "string" } ], "type": "list" }, { - "description": "the total volume which can be used by this account", - "name": "volumelimit", + "description": "the state of the account", + "name": "state", "type": "string" }, { - "description": "the total memory (in MB) available to be created for this account", - "name": "memoryavailable", + "description": "the date when this account was created", + "name": "created", + "type": "date" + }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the total number of cpu cores the account can own", + "name": "cpulimit", "type": "string" }, { - "description": "true if the account requires cleanup", - "name": "iscleanuprequired", - "type": "boolean" + "description": "the total number of vpcs the account can own", + "name": "vpclimit", + "type": "string" }, { "description": "the total number of templates which have been created by this account", @@ -51275,29 +52803,95 @@ "type": "long" }, { - "description": "the total volume being used by this account", - "name": "volumetotal", - "type": "long" + "description": "the total number of snapshots which can be stored by this account", + "name": "snapshotlimit", + "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", + "type": "string" }, { - "description": "id of the Domain the account belongs to", - "name": "domainid", + "description": "the total volume which can be used by this account", + "name": "volumelimit", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the total number of public ip addresses available for this account to acquire", + "name": "ipavailable", "type": "string" }, + {}, { - "description": "the total number of templates available to be created by this account", - "name": "templateavailable", + "description": "the list of acl groups that account belongs to", + "name": "groups", + "type": "list" + }, + { + "description": "the total number of projects available for administration by this account", + "name": "projectavailable", + "type": "string" + }, + { + "description": "the total number of snapshots available for this account", + "name": "snapshotavailable", + "type": "string" + }, + { + "description": "the ID of the role", + "name": "roleid", + "type": "string" + }, + { + "description": "the total number of cpu cores available to be created for this account", + "name": "cpuavailable", + "type": "string" + }, + { + "description": "the total number of virtual machines that can be deployed by this account", + "name": "vmlimit", + "type": "string" + }, + { + "description": "the total secondary storage space (in GiB) available to be used for this account", + "name": "secondarystorageavailable", + "type": "string" + }, + { + "description": "the total number of virtual machines available for this account to acquire", + "name": "vmavailable", + "type": "string" + }, + { + "description": "name of the Domain the account belongs to", + "name": "domain", + "type": "string" + }, + { + "description": "the total number of snapshots stored by this account", + "name": "snapshottotal", + "type": "long" + }, + { + "description": "the total primary storage space (in GiB) owned by account", + "name": "primarystoragetotal", + "type": "long" + }, + { + "description": "the total secondary storage space (in GiB) the account can own", + "name": "secondarystoragelimit", + "type": "string" + }, + { + "description": "the default zone of the account", + "name": "defaultzoneid", "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ] }, @@ -51307,25 +52901,19 @@ "name": "listDomains", "params": [ { - "description": "flag to display the resource icon for domains", - "length": 255, - "name": "showicon", - "required": false, - "type": "boolean" - }, - { - "description": "List domain by domain name.", + "description": "List domains by domain level.", "length": 255, - "name": "name", + "name": "level", "required": false, - "type": "string" + "type": "integer" }, { - "description": "", + "description": "List domain by domain ID.", "length": 255, - "name": "page", + "name": "id", + "related": "listDomainChildren,listDomains,listDomains", "required": false, - "type": "integer" + "type": "uuid" }, { "description": "comma separated list of domain details requested, value can be a list of [ all, resource, min]", @@ -51337,17 +52925,16 @@ { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, { - "description": "List domain by domain ID.", + "description": "", "length": 255, - "name": "id", - "related": "listDomainChildren,listDomains,listDomains", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" }, { "description": "List by keyword", @@ -51357,80 +52944,73 @@ "type": "string" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false", + "description": "flag to display the resource icon for domains", "length": 255, - "name": "listall", + "name": "showicon", "required": false, "type": "boolean" }, { - "description": "List domains by domain level.", + "description": "List domain by domain name.", "length": 255, - "name": "level", + "name": "name", "required": false, - "type": "integer" + "type": "string" + }, + { + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false", + "length": 255, + "name": "listall", + "required": false, + "type": "boolean" } ], "related": "listDomainChildren,listDomains", "response": [ { - "description": "the total secondary storage space (in GiB) owned by domain", - "name": "secondarystoragetotal", - "type": "float" - }, - { - "description": "the total volume available for this domain", - "name": "volumeavailable", + "description": "the total number of cpu cores available to be created for this domain", + "name": "cpuavailable", "type": "string" }, { - "description": "the total number of virtual machines deployed by this domain", - "name": "vmtotal", + "description": "the total memory (in MB) owned by domain", + "name": "memorytotal", "type": "long" }, { - "description": "the total number of public ip addresses this domain can acquire", - "name": "iplimit", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the total number of vpcs the domain can own", - "name": "vpclimit", + "description": "the total number of networks the domain can own", + "name": "networklimit", "type": "string" }, { - "description": "the total number of projects the domain can own", - "name": "projectlimit", + "description": "the total primary storage space (in GiB) available to be used for this domain", + "name": "primarystorageavailable", "type": "string" }, { - "description": "the total secondary storage space (in GiB) available to be used for this domain", - "name": "secondarystorageavailable", + "description": "the total number of cpu cores the domain can own", + "name": "cpulimit", "type": "string" }, { - "description": "the total memory (in MB) available to be created for this domain", - "name": "memoryavailable", + "description": "the total number of networks available to be created for this domain", + "name": "networkavailable", "type": "string" }, - { - "description": "details for the domain", - "name": "domaindetails", - "type": "map" - }, { "description": "the network domain", "name": "networkdomain", "type": "string" }, + {}, { - "description": "the domain name of the parent domain", - "name": "parentdomainname", - "type": "string" - }, - { - "description": "the total number of networks owned by domain", - "name": "networktotal", + "description": "the total volume being used by this domain", + "name": "volumetotal", "type": "long" }, { @@ -51439,43 +53019,38 @@ "type": "string" }, { - "description": "the total primary storage space (in GiB) owned by domain", - "name": "primarystoragetotal", - "type": "long" - }, - { - "description": "the total number of templates available to be created by this domain", - "name": "templateavailable", + "description": "the total number of public ip addresses this domain can acquire", + "name": "iplimit", "type": "string" }, { - "description": "the total number of virtual machines available for this domain to acquire", - "name": "vmavailable", + "description": "the total number of public ip addresses available for this domain to acquire", + "name": "ipavailable", "type": "string" }, { - "description": "whether the domain has one or more sub-domains", - "name": "haschild", - "type": "boolean" + "description": "the total primary storage space (in GiB) owned by domain", + "name": "primarystoragetotal", + "type": "long" }, { - "description": "the total number of snapshots stored by this domain", - "name": "snapshottotal", + "description": "the total number of virtual machines deployed by this domain", + "name": "vmtotal", "type": "long" }, { - "description": "the total number of networks the domain can own", - "name": "networklimit", - "type": "string" + "description": "whether the domain has one or more sub-domains", + "name": "haschild", + "type": "boolean" }, { - "description": "the path of the domain", - "name": "path", - "type": "string" + "description": "the total number of public ip addresses allocated for this domain", + "name": "iptotal", + "type": "long" }, { - "description": "the total number of projects available for administration by this domain", - "name": "projectavailable", + "description": "the total number of virtual machines available for this domain to acquire", + "name": "vmavailable", "type": "string" }, { @@ -51484,151 +53059,170 @@ "type": "boolean" }, { - "description": "the total number of templates which can be created by this domain", - "name": "templatelimit", + "description": "the total number of snapshots which can be stored by this domain", + "name": "snapshotlimit", "type": "string" }, { - "description": "the total number of virtual machines that can be deployed by this domain", - "name": "vmlimit", + "description": "the total number of projects the domain can own", + "name": "projectlimit", "type": "string" }, { - "description": "the total number of public ip addresses available for this domain to acquire", - "name": "ipavailable", - "type": "string" + "description": "the level of the domain", + "name": "level", + "type": "integer" }, { - "description": "the total primary storage space (in GiB) available to be used for this domain", - "name": "primarystorageavailable", + "description": "the total secondary storage space (in GiB) available to be used for this domain", + "name": "secondarystorageavailable", "type": "string" }, { - "description": "the total secondary storage space (in GiB) the domain can own", - "name": "secondarystoragelimit", + "description": "the total number of snapshots available for this domain", + "name": "snapshotavailable", "type": "string" }, { - "description": "the total number of vpcs owned by domain", - "name": "vpctotal", - "type": "long" + "description": "the total number of templates available to be created by this domain", + "name": "templateavailable", + "type": "string" }, { - "description": "the total number of vpcs available to be created for this domain", - "name": "vpcavailable", + "description": "the total number of vpcs the domain can own", + "name": "vpclimit", "type": "string" }, + { + "description": "the total number of projects being administrated by this domain", + "name": "projecttotal", + "type": "long" + }, { "description": "the domain ID of the parent domain", "name": "parentdomainid", "type": "string" }, { - "description": "the total number of templates which have been created by this domain", - "name": "templatetotal", - "type": "long" + "description": "the total number of projects available for administration by this domain", + "name": "projectavailable", + "type": "string" }, { - "description": "the total volume being used by this domain", - "name": "volumetotal", - "type": "long" + "description": "the domain name of the parent domain", + "name": "parentdomainname", + "type": "string" }, { - "description": "the total memory (in MB) the domain can own", - "name": "memorylimit", + "description": "the total number of templates which can be created by this domain", + "name": "templatelimit", "type": "string" }, { - "description": "the total number of cpu cores available to be created for this domain", - "name": "cpuavailable", - "type": "string" + "description": "details for the domain", + "name": "domaindetails", + "type": "map" }, { - "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) owned by domain", + "name": "secondarystoragetotal", + "type": "float" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the total number of cpu cores owned by domain", + "name": "cputotal", + "type": "long" }, { - "description": "the date when this domain was created", - "name": "created", - "type": "date" + "description": "the total secondary storage space (in GiB) the domain can own", + "name": "secondarystoragelimit", + "type": "string" }, { - "description": "the level of the domain", - "name": "level", - "type": "integer" + "description": "the total primary storage space (in GiB) the domain can own", + "name": "primarystoragelimit", + "type": "string" }, - {}, { - "description": "the name of the domain", - "name": "name", + "description": "the total number of vpcs available to be created for this domain", + "name": "vpcavailable", "type": "string" }, - {}, { - "description": "the total number of projects being administrated by this domain", - "name": "projecttotal", + "description": "the total number of snapshots stored by this domain", + "name": "snapshottotal", "type": "long" }, { - "description": "the total number of public ip addresses allocated for this domain", - "name": "iptotal", - "type": "long" + "description": "the date when this domain was created", + "name": "created", + "type": "date" }, { - "description": "the total number of snapshots available for this domain", - "name": "snapshotavailable", + "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 state of the domain", "name": "state", "type": "string" }, { - "description": "the total primary storage space (in GiB) the domain can own", - "name": "primarystoragelimit", + "description": "the total number of virtual machines that can be deployed by this domain", + "name": "vmlimit", "type": "string" }, { - "description": "the total number of cpu cores owned by domain", - "name": "cputotal", + "description": "the total number of templates which have been created by this domain", + "name": "templatetotal", "type": "long" }, + { + "description": "the name of the domain", + "name": "name", + "type": "string" + }, { "description": "the ID of the domain", "name": "id", "type": "string" }, { - "description": "the total number of snapshots which can be stored by this domain", - "name": "snapshotlimit", + "description": "the total memory (in MB) the domain can own", + "name": "memorylimit", "type": "string" }, + {}, { - "description": "the total memory (in MB) owned by domain", - "name": "memorytotal", + "description": "the total number of vpcs owned by domain", + "name": "vpctotal", "type": "long" }, { - "description": "the total number of cpu cores the domain can own", - "name": "cpulimit", - "type": "string" + "description": "the total number of networks owned by domain", + "name": "networktotal", + "type": "long" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the total volume available for this domain", + "name": "volumeavailable", + "type": "string" }, { "description": "the total volume which can be used by this domain", "name": "volumelimit", "type": "string" + }, + { + "description": "the total memory (in MB) available to be created for this domain", + "name": "memoryavailable", + "type": "string" } ] }, @@ -51638,17 +53232,9 @@ "name": "updateNetwork", "params": [ { - "description": "the ID of the network", - "length": 255, - "name": "id", - "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listF5LoadBalancerNetworks,listNetscalerLoadBalancerNetworks,listSrxFirewallNetworks,listBrocadeVcsDeviceNetworks", - "required": true, - "type": "uuid" - }, - { - "description": "the new display text for the network", + "description": "network domain", "length": 255, - "name": "displaytext", + "name": "networkdomain", "required": false, "type": "string" }, @@ -51660,12 +53246,18 @@ "type": "boolean" }, { - "description": "network offering ID", + "description": "the new name for the network", "length": 255, - "name": "networkofferingid", - "related": "listNetworkOfferings", + "name": "name", "required": false, - "type": "uuid" + "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": "Force update even if CIDR type is different", @@ -51674,6 +53266,21 @@ "required": false, "type": "boolean" }, + { + "description": "the ID of the network", + "length": 255, + "name": "id", + "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listSrxFirewallNetworks,listBrocadeVcsDeviceNetworks", + "required": true, + "type": "uuid" + }, + { + "description": "when true ip address usage for the network will not be exported by the listUsageRecords API", + "length": 255, + "name": "hideipaddressusage", + "required": false, + "type": "boolean" + }, { "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", "length": 255, @@ -51682,6 +53289,13 @@ "since": "4.4", "type": "string" }, + { + "description": "the new display text for the network", + "length": 255, + "name": "displaytext", + "required": false, + "type": "string" + }, { "description": "CIDR for guest VMs, CloudStack allocates IPs to guest VMs only from this CIDR", "length": 255, @@ -51690,126 +53304,126 @@ "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": "network offering ID", + "length": 255, + "name": "networkofferingid", + "related": "listNetworkOfferings", + "required": false, + "type": "uuid" + }, + { + "description": "Setting this to true will cause a forced network update,", + "length": 255, + "name": "forced", + "required": false, + "type": "boolean" + } + ], + "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listSrxFirewallNetworks,listBrocadeVcsDeviceNetworks", + "response": [ + { + "description": "true network requires restart", + "name": "restartrequired", + "type": "boolean" + }, + { + "description": "If the network has redundant routers enabled", + "name": "redundantrouter", "type": "boolean" }, { - "description": "Setting this to true will cause a forced network update,", - "length": 255, - "name": "forced", - "required": false, + "description": "true if guest network default egress policy is allow; false if default egress policy is deny", + "name": "egressdefaultpolicy", "type": "boolean" }, { - "description": "an optional field, whether to the display the network to the end user or not.", - "length": 255, - "name": "displaynetwork", - "required": false, + "description": "list networks available for vm deployment", + "name": "canusefordeploy", "type": "boolean" }, { - "description": "network domain", - "length": 255, - "name": "networkdomain", - "required": false, - "type": "string" + "description": "true if network supports specifying ip ranges, false otherwise", + "name": "specifyipranges", + "type": "boolean" }, - { - "description": "the new name for the network", - "length": 255, - "name": "name", - "required": false, - "type": "string" - } - ], - "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listF5LoadBalancerNetworks,listNetscalerLoadBalancerNetworks,listSrxFirewallNetworks,listBrocadeVcsDeviceNetworks", - "response": [ - {}, { "description": "the domain name of the network owner", "name": "domain", "type": "string" }, { - "description": "ACL name associated with the VPC network", - "name": "aclname", + "description": "the ID of the Network associated with this private gateway", + "name": "associatednetworkid", "type": "string" }, { - "description": "the displaytext of the network", - "name": "displaytext", + "description": "the physical network id", + "name": "physicalnetworkid", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the id of the network", + "name": "id", + "type": "string" }, { - "description": "the second DNS for the network", - "name": "dns2", + "description": "the displaytext of the network", + "name": "displaytext", "type": "string" }, { - "description": "the network's IP range not to be used by CloudStack guest VMs and can be used for non CloudStack purposes", - "name": "reservediprange", + "description": "the name of the Network associated with this private gateway", + "name": "associatednetwork", "type": "string" }, { - "description": "Broadcast domain type of the network", - "name": "broadcastdomaintype", + "description": "the network CIDR of the guest network configured with IP reservation. It is the summation of CIDR and RESERVED_IP_RANGE", + "name": "networkcidr", "type": "string" }, { - "description": "the type of the network", - "name": "type", - "type": "string" + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" }, { - "description": "true if network supports specifying ip ranges, false otherwise", - "name": "specifyipranges", - "type": "boolean" + "description": "the network's netmask", + "name": "netmask", + "type": "string" }, { - "description": "display text of the network offering the network is created from", - "name": "networkofferingdisplaytext", + "description": "availability of the network offering the network is created from", + "name": "networkofferingavailability", "type": "string" }, { - "description": "true if network offering is ip conserve mode enabled", - "name": "networkofferingconservemode", - "type": "boolean" + "description": "the domain id of the network owner", + "name": "domainid", + "type": "string" }, { - "description": "true if network can span multiple zones", - "name": "strechedl2subnet", - "type": "boolean" + "description": "state of the network", + "name": "state", + "type": "string" }, { - "description": "true if network is system, false otherwise", - "name": "issystem", - "type": "boolean" + "description": "zone id of the network", + "name": "zoneid", + "type": "string" }, { - "description": "list networks that are persistent", - "name": "ispersistent", - "type": "boolean" + "description": "the network domain", + "name": "networkdomain", + "type": "string" }, + {}, { "description": "the list of resource tags associated with network", "name": "tags", "response": [ { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { @@ -51817,19 +53431,14 @@ "name": "value", "type": "string" }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, { "description": "the project name where tag belongs to", "name": "project", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { @@ -51837,6 +53446,11 @@ "name": "account", "type": "string" }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, { "description": "resource type", "name": "resourcetype", @@ -51848,38 +53462,28 @@ "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", "type": "string" } ], "type": "list" }, { - "description": "If a network is enabled for 'streched l2 subnet' then represents zones on which network currently spans", - "name": "zonesnetworkspans", - "type": "set" - }, - { - "description": "The external id of the network", - "name": "externalid", - "type": "string" - }, - { - "description": "name of the network offering the network is created from", - "name": "networkofferingname", - "type": "string" + "description": "true if network offering is ip conserve mode enabled", + "name": "networkofferingconservemode", + "type": "boolean" }, { - "description": "the id of the network", - "name": "id", + "description": "the project name of the address", + "name": "project", "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", @@ -51891,230 +53495,99 @@ "type": "string" }, { - "description": "the network's netmask", - "name": "netmask", - "type": "string" - }, - {}, - { - "description": "zone id of the network", - "name": "zoneid", - "type": "string" - }, - { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "VPC the network belongs to", - "name": "vpcid", + "description": "the first DNS for the network", + "name": "dns1", "type": "string" }, { - "description": "acl type - access type to the network", - "name": "acltype", + "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": "network offering id the network is created from", - "name": "networkofferingid", + "description": "the name of the Network associated with this network", + "name": "associatednetwork", "type": "string" }, { - "description": "If the network has redundant routers enabled", - "name": "redundantrouter", - "type": "boolean" - }, - { - "description": "the network's gateway", - "name": "gateway", + "description": "the type of the network", + "name": "type", "type": "string" }, { - "description": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR", - "name": "cidr", + "description": "The external id of the network", + "name": "externalid", "type": "string" }, + {}, { - "description": "the physical network id", - "name": "physicalnetworkid", - "type": "string" + "description": "the date this network was created", + "name": "created", + "type": "date" }, { - "description": "broadcast uri of the network. This parameter is visible to ROOT admins only", - "name": "broadcasturi", - "type": "string" + "description": "The routes for the network to ease adding route in upstream router", + "name": "ip6routes", + "type": "set" }, { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "the name of the zone the network belongs to", + "name": "zonename", "type": "string" }, { - "description": "The vlan of the network. This parameter is visible to ROOT admins only", - "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 gateway of IPv6 network", - "name": "ip6gateway", + "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", + "description": "the ID of the Network associated with this network", + "name": "associatednetworkid", "type": "string" }, { - "description": "true if users from subdomains can access the domain level network", - "name": "subdomainaccess", - "type": "boolean" - }, - { - "description": "the owner of the network", - "name": "account", + "description": "network offering id the network is created from", + "name": "networkofferingid", "type": "string" }, { - "description": "availability of the network offering the network is created from", - "name": "networkofferingavailability", + "description": "Broadcast domain type of the network", + "name": "broadcastdomaintype", "type": "string" }, { - "description": "list networks available for vm deployment", - "name": "canusefordeploy", + "description": "list networks that are persistent", + "name": "ispersistent", "type": "boolean" }, { - "description": "the network domain", - "name": "networkdomain", - "type": "string" - }, - { - "description": "the first DNS for the network", - "name": "dns1", - "type": "string" - }, - { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the network's IP range not to be used by CloudStack guest VMs and can be used for non CloudStack purposes", + "name": "reservediprange", "type": "string" }, { - "description": "the date this network was created", - "name": "created", - "type": "date" - }, - { - "description": "the details of the network", - "name": "details", - "type": "map" - }, - { - "description": "the list of services", - "name": "service", - "response": [ - { - "description": "the service name", - "name": "name", - "type": "string" - }, - { - "description": "the list of capabilities", - "name": "capability", - "response": [ - { - "description": "the capability name", - "name": "name", - "type": "string" - }, - { - "description": "the capability value", - "name": "value", - "type": "string" - }, - { - "description": "can this service capability value can be choosable while creatine network offerings", - "name": "canchooseservicecapability", - "type": "boolean" - } - ], - "type": "list" - }, - { - "description": "the service provider name", - "name": "provider", - "response": [ - { - "description": "state of the network provider", - "name": "state", - "type": "string" - }, - { - "description": "services for this provider", - "name": "servicelist", - "type": "list" - }, - { - "description": "true if individual services can be enabled/disabled", - "name": "canenableindividualservice", - "type": "boolean" - }, - { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", - "type": "string" - }, - { - "description": "uuid of the network provider", - "name": "id", - "type": "string" - }, - { - "description": "the destination physical network", - "name": "destinationphysicalnetworkid", - "type": "string" - }, - { - "description": "the provider name", - "name": "name", - "type": "string" - } - ], - "type": "list" - } - ], - "type": "list" - }, - { - "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": "the domain id of the network owner", - "name": "domainid", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "an optional field, whether to the display the network to the end user or not.", - "name": "displaynetwork", - "type": "boolean" - }, - { - "description": "the name of the network", - "name": "name", + "description": "VPC the network belongs to", + "name": "vpcid", "type": "string" }, { - "description": "the project name of the address", - "name": "project", + "description": "the network's gateway", + "name": "gateway", "type": "string" }, { @@ -52123,231 +53596,197 @@ "type": "boolean" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" - }, - { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" - }, - { - "description": "related to what other network configuration", - "name": "related", - "type": "string" - }, - { - "description": "the name of the zone the network belongs to", - "name": "zonename", - "type": "string" + "description": "true if users from subdomains can access the domain level network", + "name": "subdomainaccess", + "type": "boolean" }, { - "description": "ACL Id associated with the VPC network", - "name": "aclid", - "type": "string" + "description": "an optional field, whether to the display the network to the end user or not.", + "name": "displaynetwork", + "type": "boolean" }, { "description": "Name of the VPC to which this network belongs", "name": "vpcname", "type": "string" - } - ] - }, - { - "description": "Lists VM backups", - "isasync": false, - "name": "listBackups", - "params": [ - { - "description": "id of the 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", - "required": false, - "type": "uuid" - }, - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" + "description": "the details of the network", + "name": "details", + "type": "map" }, { - "description": "list resources by account. Must be used with the domainId parameter.", - "length": 255, - "name": "account", - "required": false, + "description": "The vlan of the network. This parameter is visible to ROOT admins only", + "name": "vlan", "type": "string" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, - { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", - "length": 255, - "name": "isrecursive", - "required": false, - "type": "boolean" - }, - { - "description": "id of the backup", - "length": 255, - "name": "id", - "related": "updateBackupSchedule,listBackups", - "required": false, - "type": "uuid" - }, - { - "description": "list backups by zone id", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": false, - "type": "uuid" - }, - { - "description": "list objects by project", - "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": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false", - "length": 255, - "name": "listall", - "required": false, + "description": "true if network is system, false otherwise", + "name": "issystem", "type": "boolean" }, { - "description": "list only resources belonging to the domain specified", - "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", - "required": false, - "type": "uuid" - } - ], - "related": "updateBackupSchedule", - "response": [ - { - "description": "ID of the VM", - "name": "virtualmachineid", - "type": "string" - }, - { - "description": "name of the VM", - "name": "virtualmachinename", - "type": "string" - }, - { - "description": "backup type", - "name": "type", - "type": "string" - }, - { - "description": "backup offering id", - "name": "backupofferingid", + "description": "name of the network offering the network is created from", + "name": "networkofferingname", "type": "string" }, - {}, { - "description": "account name", - "name": "account", + "description": "the second DNS for the network", + "name": "dns2", "type": "string" }, { - "description": "ID of the VM backup", - "name": "id", + "description": "the name of the network", + "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": "zoneid", + "description": "The internet protocol of network offering", + "name": "internetprotocol", "type": "string" }, { - "description": "domain id", - "name": "domainid", + "description": "ACL name associated with the VPC network", + "name": "aclname", "type": "string" }, { - "description": "external backup id", - "name": "externalid", + "description": "the project id of the ipaddress", + "name": "projectid", "type": "string" }, { - "description": "domain name", - "name": "domain", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "backup date", - "name": "created", + "description": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR", + "name": "cidr", "type": "string" }, { - "description": "backup status", - "name": "status", - "type": "status" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "zone name", - "name": "zone", + "description": "acl type - access type to the network", + "name": "acltype", "type": "string" }, { - "description": "account id", - "name": "accountid", + "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 routing mode of network offering", + "name": "ip6routing", "type": "string" }, { - "description": "backup protected (virtual) size in bytes", - "name": "virtualsize", - "type": "long" + "description": "broadcast uri of the network. This parameter is visible to ROOT admins only", + "name": "broadcasturi", + "type": "string" }, - {}, { - "description": "backup offering name", - "name": "backupofferingname", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "backed up volumes", - "name": "volumes", + "description": "true if network can span multiple zones", + "name": "strechedl2subnet", + "type": "boolean" + }, + { + "description": "related to what other network configuration", + "name": "related", "type": "string" }, { - "description": "backup size in bytes", - "name": "size", - "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 name", + "name": "name", + "type": "string" + }, + { + "description": "the service provider name", + "name": "provider", + "response": [ + { + "description": "state of the network provider", + "name": "state", + "type": "string" + }, + { + "description": "uuid of the network provider", + "name": "id", + "type": "string" + }, + { + "description": "true if individual services can be enabled/disabled", + "name": "canenableindividualservice", + "type": "boolean" + }, + { + "description": "the physical network this belongs to", + "name": "physicalnetworkid", + "type": "string" + }, + { + "description": "the destination physical network", + "name": "destinationphysicalnetworkid", + "type": "string" + }, + { + "description": "the provider name", + "name": "name", + "type": "string" + }, + { + "description": "services for this provider", + "name": "servicelist", + "type": "list" + } + ], + "type": "list" + } + ], + "type": "list" } - ], - "since": "4.14.0" + ] }, { "description": "List Usage Types", @@ -52361,64 +53800,24 @@ "name": "description", "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": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" - } - ] - }, - { - "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 current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the CA service provider name", - "name": "name", - "type": "string" + "description": "usage type", + "name": "usagetypeid", + "type": "integer" }, {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the description of the CA service provider", - "name": "description", - "type": "string" - } - ], - "since": "4.14.0" + {} + ] }, { "description": "Deletes a template from the system. All virtual machines using the deleted template will not be affected.", @@ -52433,14 +53832,6 @@ "required": true, "type": "uuid" }, - { - "description": "the ID of zone of the template", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": false, - "type": "uuid" - }, { "description": "Force delete a template.", "length": 255, @@ -52448,30 +53839,38 @@ "required": false, "since": "4.9+", "type": "boolean" + }, + { + "description": "the ID of zone of the template", + "length": 255, + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": false, + "type": "uuid" } ], "response": [ {}, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, + {}, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" } ] }, @@ -52481,27 +53880,13 @@ "name": "listNetworkACLLists", "params": [ { - "description": "Lists network ACL with the specified ID.", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "id", - "related": "createNetworkACLList,listNetworkACLLists", + "name": "domainid", + "related": "listDomainChildren,listDomains", "required": false, "type": "uuid" }, - { - "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", - "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, @@ -52510,12 +53895,11 @@ "type": "boolean" }, { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "description": "List by keyword", "length": 255, - "name": "fordisplay", + "name": "keyword", "required": false, - "since": "4.4", - "type": "boolean" + "type": "string" }, { "description": "", @@ -52525,26 +53909,18 @@ "type": "integer" }, { - "description": "list resources by account. Must be used with the domainId parameter.", - "length": 255, - "name": "account", - "required": false, - "type": "string" - }, - { - "description": "list network ACLs by specified name", + "description": "", "length": 255, - "name": "name", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { - "description": "list objects by project", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", + "name": "listall", "required": false, - "type": "uuid" + "type": "boolean" }, { "description": "list network ACLs by VPC ID", @@ -52558,59 +53934,87 @@ "description": "list network ACLs by network ID", "length": 255, "name": "networkid", - "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listF5LoadBalancerNetworks,listNetscalerLoadBalancerNetworks,listSrxFirewallNetworks,listBrocadeVcsDeviceNetworks", + "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listSrxFirewallNetworks,listBrocadeVcsDeviceNetworks", "required": false, "type": "uuid" }, { - "description": "list only resources belonging to the domain specified", + "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", + "name": "fordisplay", + "required": false, + "since": "4.4", + "type": "boolean" + }, + { + "description": "list network ACLs by specified name", + "length": 255, + "name": "name", + "required": false, + "type": "string" + }, + { + "description": "Lists network ACL with the specified ID.", + "length": 255, + "name": "id", + "related": "createNetworkACLList,listNetworkACLLists", "required": false, "type": "uuid" }, { - "description": "List by keyword", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "keyword", + "name": "account", "required": false, "type": "string" + }, + { + "description": "list objects by project; if projectid=-1 lists All VMs", + "length": 255, + "name": "projectid", + "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", + "required": false, + "type": "uuid" } ], "related": "createNetworkACLList", "response": [ - {}, { - "description": "is ACL for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "Id of the VPC this ACL is associated with", - "name": "vpcid", + "description": "Name of the VPC this ACL is associated with", + "name": "vpcname", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "is ACL for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, - {}, { "description": "the Name of the ACL", "name": "name", "type": "string" }, + {}, + {}, { "description": "the ID of the ACL", "name": "id", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "Id of the VPC this ACL is associated with", + "name": "vpcid", + "type": "string" }, { "description": "Description of the ACL", @@ -52635,45 +54039,14 @@ ], "related": "revertSnapshot", "response": [ - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "physical size of backedup snapshot on image store", - "name": "physicalsize", - "type": "long" - }, - {}, - { - "description": "the domain ID of the snapshot's account", - "name": "domainid", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "valid types are hourly, daily, weekly, monthy, template, and none.", - "name": "intervaltype", - "type": "string" - }, { "description": "virtual size of backedup snapshot on image store", "name": "virtualsize", "type": "long" }, { - "description": "ID of the disk volume", - "name": "volumeid", - "type": "string" - }, - { - "description": "ID of the snapshot", - "name": "id", + "description": "the project id of the snapshot", + "name": "projectid", "type": "string" }, { @@ -52682,18 +54055,18 @@ "type": "string" }, { - "description": "the domain name of the snapshot's account", - "name": "domain", + "description": "display name of the os on volume", + "name": "osdisplayname", "type": "string" }, { - "description": "the state of the snapshot. BackedUp means that snapshot is ready to be used; Creating - the snapshot is being allocated on the primary storage; BackingUp - the snapshot is being backed up on secondary storage", - "name": "state", - "type": "state" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "display name of the os on volume", - "name": "osdisplayname", + "description": "valid location types are primary and secondary.", + "name": "locationtype", "type": "string" }, { @@ -52701,18 +54074,18 @@ "name": "tags", "response": [ { - "description": "tag key name", - "name": "key", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { @@ -52721,28 +54094,28 @@ "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the 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 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" }, { @@ -52754,18 +54127,18 @@ "type": "set" }, { - "description": "type of the disk volume", - "name": "volumetype", - "type": "string" + "description": "physical size of backedup snapshot on image store", + "name": "physicalsize", + "type": "long" }, { - "description": "name of the snapshot", - "name": "name", + "description": "id of the os on volume", + "name": "ostypeid", "type": "string" }, { - "description": "valid location types are primary and secondary.", - "name": "locationtype", + "description": "ID of the snapshot", + "name": "id", "type": "string" }, { @@ -52773,15 +54146,40 @@ "name": "account", "type": "string" }, - {}, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, { "description": "the type of the snapshot", "name": "snapshottype", "type": "string" }, { - "description": "id of the os on volume", - "name": "ostypeid", + "description": "the domain ID of the snapshot's account", + "name": "domainid", + "type": "string" + }, + { + "description": "indicates whether the underlying storage supports reverting the volume to this snapshot", + "name": "revertable", + "type": "boolean" + }, + { + "description": "type of the disk volume", + "name": "volumetype", + "type": "string" + }, + { + "description": "name of the disk volume", + "name": "volumename", + "type": "string" + }, + {}, + { + "description": "name of the snapshot", + "name": "name", "type": "string" }, { @@ -52789,10 +54187,11 @@ "name": "zoneid", "type": "string" }, + {}, { - "description": "the project name of the snapshot", - "name": "project", - "type": "string" + "description": "the state of the snapshot. BackedUp means that snapshot is ready to be used; Creating - the snapshot is being allocated on the primary storage; BackingUp - the snapshot is being backed up on secondary storage", + "name": "state", + "type": "state" }, { "description": " the date the snapshot was created", @@ -52800,18 +54199,23 @@ "type": "date" }, { - "description": "indicates whether the underlying storage supports reverting the volume to this snapshot", - "name": "revertable", - "type": "boolean" + "description": "the domain name of the snapshot's account", + "name": "domain", + "type": "string" }, { - "description": "the project id of the snapshot", - "name": "projectid", + "description": "valid types are hourly, daily, weekly, monthy, template, and none.", + "name": "intervaltype", "type": "string" }, { - "description": "name of the disk volume", - "name": "volumename", + "description": "ID of the disk volume", + "name": "volumeid", + "type": "string" + }, + { + "description": "the project name of the snapshot", + "name": "project", "type": "string" } ] @@ -52831,18 +54235,13 @@ } ], "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", @@ -52852,6 +54251,11 @@ "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" } ] }, @@ -52860,14 +54264,6 @@ "isasync": true, "name": "updateVpnGateway", "params": [ - { - "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", - "length": 255, - "name": "customid", - "required": false, - "since": "4.4", - "type": "string" - }, { "description": "id of customer gateway", "length": 255, @@ -52883,44 +54279,58 @@ "required": false, "since": "4.4", "type": "boolean" + }, + { + "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", + "length": 255, + "name": "customid", + "required": false, + "since": "4.4", + "type": "string" } ], "related": "createVpnGateway,listVpnGateways", "response": [ { - "description": "the project id", - "name": "projectid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the vpn gateway ID", - "name": "id", + "description": "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 domain name of the owner", + "name": "domain", + "type": "string" + }, + { + "description": "the vpc id of this gateway", + "name": "vpcid", + "type": "string" }, { - "description": "the domain id of the owner", - "name": "domainid", + "description": "the project id", + "name": "projectid", "type": "string" }, { - "description": "the vpc name of this gateway", - "name": "vpcname", + "description": "the domain id of the owner", + "name": "domainid", "type": "string" }, - {}, { "description": "the owner", "name": "account", "type": "string" }, { - "description": "the public IP address", - "name": "publicip", + "description": "the vpc name of this gateway", + "name": "vpcname", "type": "string" }, { @@ -52928,31 +54338,25 @@ "name": "fordisplay", "type": "boolean" }, - { - "description": "the vpc id of this gateway", - "name": "vpcid", - "type": "string" - }, - { - "description": "the domain name of the owner", - "name": "domain", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - {}, { "description": "the project name", "name": "project", "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 vpn gateway ID", + "name": "id", + "type": "string" } ], "since": "4.4" @@ -52972,28 +54376,28 @@ } ], "response": [ + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, + {}, { "description": "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" - }, - {}, - {} + } ] }, { @@ -53002,20 +54406,11 @@ "name": "deleteSecurityGroup", "params": [ { - "description": "the domain ID of account owning the security group", - "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", - "required": false, - "type": "uuid" - }, - { - "description": "the project of the security group", + "description": "The ID of the security group. Mutually exclusive with id parameter", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", + "name": "name", "required": false, - "type": "uuid" + "type": "string" }, { "description": "the account of the security group. Must be specified with domain ID", @@ -53033,11 +54428,20 @@ "type": "uuid" }, { - "description": "The ID of the security group. Mutually exclusive with id parameter", + "description": "the domain ID of account owning the security group", "length": 255, - "name": "name", + "name": "domainid", + "related": "listDomainChildren,listDomains", "required": false, - "type": "string" + "type": "uuid" + }, + { + "description": "the project of the security group", + "length": 255, + "name": "projectid", + "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", + "required": false, + "type": "uuid" } ], "response": [ @@ -53046,23 +54450,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" - }, - {} + } ] }, { @@ -53071,21 +54475,13 @@ "name": "migrateVirtualMachine", "params": [ { - "description": "Destination storage pool ID to migrate VM volumes to. Required for migrating the root disk volume", + "description": "Destination Host ID to migrate VM to.", "length": 255, - "name": "storageid", - "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool", + "name": "hostid", + "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost", "required": false, "type": "uuid" }, - { - "description": "the ID of the virtual machine", - "length": 255, - "name": "virtualmachineid", - "related": "migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,startVirtualMachine,stopVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance", - "required": true, - "type": "uuid" - }, { "description": "Automatically select a destination host which do not require storage migration, if hostId and storageId are not specified. false by default", "length": 255, @@ -53095,115 +54491,63 @@ "type": "boolean" }, { - "description": "Destination Host ID to migrate VM to.", + "description": "Destination storage pool ID to migrate VM volumes to. Required for migrating the root disk volume", "length": 255, - "name": "hostid", - "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost,addBaremetalHost", + "name": "storageid", + "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool", "required": false, "type": "uuid" + }, + { + "description": "the ID of the virtual machine", + "length": 255, + "name": "virtualmachineid", + "related": "migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,startVirtualMachine,stopVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance", + "required": true, + "type": "uuid" } ], "related": "migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,startVirtualMachine,stopVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance", "response": [ { - "description": "the target memory in vm", - "name": "memorytargetkbs", - "type": "long" - }, - { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", - "type": "string" - }, - { - "description": "device type of the root volume", - "name": "rootdevicetype", - "type": "string" - }, - { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", - "type": "string" - }, - { - "description": "the group name of the virtual machine", - "name": "group", - "type": "string" - }, - { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" - }, - { - "description": "Guest vm Boot Mode", - "name": "bootmode", - "type": "string" - }, - { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", - "type": "boolean" - }, - { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", - "type": "string" - }, - { - "description": "the group ID of the virtual machine", - "name": "groupid", + "description": "the 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": "the project id of the vm", + "name": "projectid", "type": "string" }, { - "description": "the pool type of the virtual machine", - "name": "pooltype", + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", "type": "string" }, { - "description": "the memory used by the vm", - "name": "memorykbs", - "type": "long" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" - }, - { - "description": "the user's name who deployed the virtual machine", - "name": "username", + "description": "the project name of the vm", + "name": "project", "type": "string" }, { - "description": "Guest vm Boot Type", - "name": "boottype", + "description": "the password (if exists) of the virtual machine", + "name": "password", "type": "string" }, { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", + "description": "OS type id of the vm", + "name": "ostypeid", "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", - "type": "string" + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", - "type": "string" + "description": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" }, { "description": "the ID of the host for the virtual machine", @@ -53216,101 +54560,56 @@ "type": "resourceiconresponse" }, { - "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": "ssh key-pair", - "name": "keypair", - "type": "string" - }, - { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", - "type": "string" - }, - { - "description": "the name of the host for the virtual machine", - "name": "hostname", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "State of the Service from LB rule", - "name": "servicestate", - "type": "string" + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "the write (io) of disk on the vm", - "name": "diskiowrite", + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", "type": "long" }, { - "description": "the read (bytes) of disk on the vm", - "name": "diskkbsread", - "type": "long" + "description": "the state of the virtual machine", + "name": "state", + "type": "string" }, { "description": "list of security groups associated with the virtual machine", "name": "securitygroup", "response": [ { - "description": "the 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 ID of the security group", + "name": "id", + "type": "string" }, { - "description": "the domain name of the security group", - "name": "domain", + "description": "the project id of the group", + "name": "projectid", "type": "string" }, { - "description": "the list of egress rules associated with the security group", - "name": "egressrule", + "description": "the list of ingress rules associated with the security group", + "name": "ingressrule", "response": [ { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "account owning the security group rule", - "name": "account", - "type": "string" - }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", + "description": "the code for the ICMP message response", + "name": "icmpcode", "type": "integer" }, { @@ -53318,28 +54617,28 @@ "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": "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": "resource type", - "name": "resourcetype", + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "tag value", + "name": "value", "type": "string" }, { @@ -53348,8 +54647,8 @@ "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "tag key name", + "name": "key", "type": "string" }, { @@ -53358,97 +54657,174 @@ "type": "string" }, { - "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 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" } ], "type": "set" }, + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, { "description": "the protocol of the security group rule", "name": "protocol", "type": "string" }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "account owning the security group rule", + "name": "account", + "type": "string" + }, { "description": "the type of the ICMP message response", "name": "icmptype", "type": "integer" + }, + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" } ], "type": "set" }, { - "description": "the domain ID of the security group", - "name": "domainid", + "description": "the description of the security group", + "name": "description", "type": "string" }, { - "description": "the list of ingress rules associated with the security group", - "name": "ingressrule", + "description": "the list of 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 code for the ICMP message response", - "name": "icmpcode", - "type": "integer" + "description": "resource type", + "name": "resourcetype", + "type": "string" }, { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" }, { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" + "description": "tag key name", + "name": "key", + "type": "string" }, { - "description": "the id of the security group rule", - "name": "ruleid", + "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 CIDR notation for the base IP address of the security group rule", - "name": "cidr", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" }, { - "description": "security group name", - "name": "securitygroupname", + "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": "the account owning the security group", + "name": "account", + "type": "string" + }, + { + "description": "the domain name of the security group", + "name": "domain", + "type": "string" + }, + { + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" + }, + { + "description": "the project name of the group", + "name": "project", + "type": "string" + }, + { + "description": "the list of egress rules associated with the security group", + "name": "egressrule", + "response": [ + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", "type": "string" }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "id of the resource", - "name": "resourceid", + "description": "tag key name", + "name": "key", "type": "string" }, { @@ -53457,13 +54833,18 @@ "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", "type": "string" }, { @@ -53472,8 +54853,8 @@ "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { @@ -53482,18 +54863,13 @@ "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "tag value", + "name": "value", "type": "string" } ], @@ -53503,186 +54879,288 @@ "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": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" }, { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" + "description": "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": "security group name", + "name": "securitygroupname", "type": "string" }, { - "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" } ], "type": "set" }, { - "description": "the account owning the security group", - "name": "account", - "type": "string" - }, - { - "description": "the project id of the group", - "name": "projectid", + "description": "the domain ID of the security group", + "name": "domainid", "type": "string" }, { "description": "the name of the security group", "name": "name", "type": "string" - }, - { - "description": "the ID of the security group", - "name": "id", - "type": "string" - }, - { - "description": "the description of the security group", - "name": "description", - "type": "string" - }, - { - "description": "the project name of the group", - "name": "project", - "type": "string" } ], "type": "set" }, { - "description": "the ID of the disk offering of the virtual machine", - "name": "diskofferingid", + "description": "Os type ID of the virtual machine", + "name": "guestosid", "type": "string" }, { - "description": "OS name of the vm", - "name": "osdisplayname", + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" + }, + { + "description": "Guest vm Boot Type", + "name": "boottype", "type": "string" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", + "description": "device ID of the root volume", + "name": "rootdeviceid", "type": "long" }, { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", "type": "boolean" }, - {}, { - "description": "the vgpu type used by the virtual machine", - "name": "vgpu", + "description": "the memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", "type": "string" }, { - "description": "the incoming network traffic on the vm", - "name": "networkkbsread", + "description": "the ID of the virtual machine", + "name": "id", + "type": "string" + }, + { + "description": "the group name of the virtual machine", + "name": "group", + "type": "string" + }, + { + "description": "the 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 group ID of the virtual machine", + "name": "groupid", + "type": "string" + }, + { + "description": "the name of the virtual machine", + "name": "name", + "type": "string" + }, + { + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", "type": "long" }, - {}, { "description": "the virtual network for the service offering", "name": "forvirtualnetwork", "type": "boolean" }, { - "description": "the account associated with the virtual machine", - "name": "account", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, + {}, + { + "description": "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", - "name": "diskofferingname", + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" + }, + { + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", "type": "string" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" + }, + { + "description": "the read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" + }, + { + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", "type": "string" }, { - "description": "the state of the virtual machine", - "name": "state", + "description": "the name of the host for the virtual machine", + "name": "hostname", "type": "string" }, { - "description": "the read (io) of disk on the vm", - "name": "diskioread", + "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": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", + "type": "string" + }, + { + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", "type": "long" }, { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "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", "type": "string" }, { - "description": "the password (if exists) of the virtual machine", - "name": "password", + "description": "device type of the root volume", + "name": "rootdevicetype", "type": "string" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" + }, + { + "description": "Guest vm Boot Mode", + "name": "bootmode", + "type": "string" + }, + { + "description": "the ID of the availablility zone for the virtual machine", + "name": "zoneid", + "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 amount of the vm's CPU currently used", + "name": "cpuused", + "type": "string" + }, + { + "description": "the pool type of the virtual machine", + "name": "pooltype", + "type": "string" + }, + { + "description": "the account associated with the virtual machine", + "name": "account", + "type": "string" + }, + { + "description": "ssh key-pairs", + "name": "keypairs", + "type": "string" + }, + { + "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", + "type": "long" + }, + { + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", + "type": "string" + }, + { + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { "description": "the list of resource tags associated", "name": "tags", "response": [ + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, { "description": "tag key name", "name": "key", @@ -53693,19 +55171,14 @@ "name": "project", "type": "string" }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, { "description": "the ID of the domain associated with the tag", "name": "domainid", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { @@ -53718,42 +55191,31 @@ "name": "domain", "type": "string" }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, { "description": "id of the resource", "name": "resourceid", "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" } ], "type": "set" }, - {}, { "description": "the list of nics associated with vm", "name": "nic", "response": [ { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", "type": "string" }, { - "description": "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", + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", "type": "string" }, { @@ -53762,13 +55224,23 @@ "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the netmask of the nic", + "name": "netmask", "type": "string" }, { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", + "type": "string" + }, + { + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { @@ -53776,30 +55248,40 @@ "name": "ipaddresses", "type": "list" }, + { + "description": "the type of the nic", + "name": "type", + "type": "string" + }, { "description": "the extra dhcp options on the nic", "name": "extradhcpoption", "type": "list" }, { - "description": "the netmask of the nic", - "name": "netmask", + "description": "the ID of the nic", + "name": "id", "type": "string" }, { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "description": "the gateway of the nic", + "name": "gateway", "type": "string" }, { - "description": "the IPv6 address of network", - "name": "ip6address", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "the gateway of the nic", - "name": "gateway", - "type": "string" + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" }, { "description": "the traffic type of the nic", @@ -53807,43 +55289,38 @@ "type": "string" }, { - "description": "the type of the nic", - "name": "type", + "description": "true if nic is default, false otherwise", + "name": "macaddress", "type": "string" }, { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "type": "string" }, { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", + "description": "the IPv6 address of network", + "name": "ip6address", "type": "string" }, { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - }, - { - "description": "the ip address of the nic", - "name": "ipaddress", + "description": "the ID of the corresponding network", + "name": "networkid", "type": "string" }, { "description": "true if nic is default, false otherwise", - "name": "macaddress", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", "type": "string" }, { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "the isolation uri of the nic", + "name": "isolationuri", "type": "string" }, { @@ -53852,67 +55329,59 @@ "type": "integer" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", - "type": "string" - }, - { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "the ip address of the nic", + "name": "ipaddress", "type": "string" }, { - "description": "the ID of the nic", - "name": "id", + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", "type": "string" }, { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" } ], "type": "set" }, { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" - }, - { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" - }, - { - "description": "the write (bytes) of disk on the vm", - "name": "diskkbswrite", - "type": "long" + "description": "the user's name who deployed the virtual machine", + "name": "username", + "type": "string" }, { - "description": "the number of cpu this virtual machine is running with", - "name": "cpunumber", - "type": "integer" + "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", + "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": "State of the Service from LB rule", + "name": "servicestate", "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 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 VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" }, { "description": "list of affinity groups associated with the virtual machine", @@ -53924,13 +55393,8 @@ "type": "string" }, { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" - }, - { - "description": "the project ID of the affinity group", - "name": "projectid", + "description": "the description of the affinity group", + "name": "description", "type": "string" }, { @@ -53939,8 +55403,13 @@ "type": "string" }, { - "description": "the description of the affinity group", - "name": "description", + "description": "the type of the affinity group", + "name": "type", + "type": "string" + }, + { + "description": "the project ID of the affinity group", + "name": "projectid", "type": "string" }, { @@ -53948,6 +55417,11 @@ "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", @@ -53958,11 +55432,6 @@ "name": "project", "type": "string" }, - { - "description": "the type of the affinity group", - "name": "type", - "type": "string" - }, { "description": "the name of the affinity group", "name": "name", @@ -53972,38 +55441,18 @@ "type": "set" }, { - "description": "the project name of the vm", - "name": "project", - "type": "string" - }, - { - "description": "the name of the virtual machine", - "name": "name", - "type": "string" - }, - { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" - }, - { - "description": "OS type id of the vm", - "name": "ostypeid", - "type": "string" - }, - { - "description": "the project id of the vm", - "name": "projectid", + "description": "the user's ID who deployed the virtual machine", + "name": "userid", "type": "string" }, { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", - "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 name of the disk offering of the virtual machine", + "name": "diskofferingname", "type": "string" }, { @@ -54012,48 +55461,13 @@ "type": "date" }, { - "description": "the internal memory that's free in vm or zero if it can not be calculated", - "name": "memoryintfreekbs", - "type": "long" - }, - { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", - "type": "string" - }, - { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" - }, - { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", - "type": "string" - }, - { - "description": "the speed of each cpu", - "name": "cpuspeed", - "type": "integer" - }, - { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", - "type": "string" - }, - { - "description": "the ID of the virtual machine", - "name": "id", + "description": "OS name of the vm", + "name": "osdisplayname", "type": "string" }, { - "description": "the outgoing network traffic on the host", - "name": "networkkbswrite", - "type": "long" - }, - { - "description": "the ID of the availablility zone for the virtual machine", - "name": "zoneid", + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", "type": "string" } ] @@ -54073,7 +55487,6 @@ } ], "response": [ - {}, { "description": "any text associated with the success or failure", "name": "displaytext", @@ -54084,119 +55497,96 @@ "name": "jobstatus", "type": "integer" }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, {} ] }, { - "description": "list baremetal rack configuration", - "isasync": false, - "name": "listBaremetalRct", + "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": "", + "description": "the tag for this template.", "length": 255, - "name": "pagesize", + "name": "templatetag", "required": false, - "type": "integer" + "type": "string" }, { - "description": "List by keyword", + "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": "keyword", + "name": "virtualmachineid", + "related": "migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,startVirtualMachine,stopVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance", "required": false, - "type": "string" + "type": "uuid" }, { - "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" - } - ], - "related": "addBaremetalRct", - "response": [ - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "type": "boolean" }, { - "description": "url", + "description": "Optional, only for baremetal hypervisor. The directory name where template stored on CIFS server", + "length": 2048, "name": "url", + "required": false, "type": "string" }, - {}, - { - "description": "id of rct", - "name": "id", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "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": "true if the template supports the sshkey upload feature; default is false", + "description": "true if this template is a public template, false otherwise", "length": 255, - "name": "sshkeyenabled", + "name": "ispublic", "required": false, "type": "boolean" }, { - "description": "true if the template requres HVM, false otherwise", + "description": "32 or 64 bit", "length": 255, - "name": "requireshvm", + "name": "bits", "required": false, - "type": "boolean" + "type": "integer" }, { - "description": "create template for the project", - "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", - "required": false, - "type": "uuid" + "description": "the display text of the template. This is usually used for display purposes.", + "length": 4096, + "name": "displaytext", + "required": true, + "type": "string" }, { - "description": "true if this template is a public template, false otherwise", + "description": "true if the template supports the password reset feature; default is false", "length": 255, - "name": "ispublic", + "name": "passwordenabled", "required": false, "type": "boolean" }, { - "description": "32 or 64 bit", + "description": "the ID of the OS Type that best represents the OS of this template.", "length": 255, - "name": "bits", - "required": false, - "type": "integer" + "name": "ostypeid", + "related": "listOsTypes,addGuestOs", + "required": true, + "type": "uuid" }, { - "description": "the tag for this template.", + "description": "Template details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].hypervisortoolsversion=xenserver61", "length": 255, - "name": "templatetag", + "name": "details", "required": false, - "type": "string" + "type": "map" }, { "description": "true if this template is a featured template, false otherwise", @@ -54214,47 +55604,32 @@ "type": "uuid" }, { - "description": "the ID of the snapshot the template is being created from. Either this parameter, or volumeId has to be passed in", + "description": "true if the template supports the sshkey upload feature; default is false", "length": 255, - "name": "snapshotid", - "related": "revertSnapshot", + "name": "sshkeyenabled", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", + "description": "true if the template requires HVM, false otherwise", "length": 255, - "name": "isdynamicallyscalable", + "name": "requireshvm", "required": false, "type": "boolean" }, { - "description": "the display text of the template. This is usually used for display purposes.", - "length": 4096, - "name": "displaytext", - "required": true, - "type": "string" - }, - { - "description": "the ID of the OS Type that best represents the OS of this template.", + "description": "create template for the project", "length": 255, - "name": "ostypeid", - "related": "listOsTypes,addGuestOs", - "required": true, - "type": "uuid" - }, - { - "description": "Optional, only for baremetal hypervisor. The directory name where template stored on CIFS server", - "length": 2048, - "name": "url", + "name": "projectid", + "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "Optional, VM ID. If this presents, it is going to create a baremetal template for VM this ID refers to. This is only for VM whose hypervisor type is BareMetal", + "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": "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": "snapshotid", + "related": "revertSnapshot", "required": false, "type": "uuid" }, @@ -54264,20 +55639,6 @@ "name": "name", "required": true, "type": "string" - }, - { - "description": "Template details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].hypervisortoolsversion=xenserver61", - "length": 255, - "name": "details", - "required": false, - "type": "map" - }, - { - "description": "true if the template supports the password reset feature; default is false", - "length": 255, - "name": "passwordenabled", - "required": false, - "type": "boolean" } ], "related": "listIsos,registerIso,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", @@ -54287,81 +55648,47 @@ "name": "zonename", "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 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": "true if template requires HVM enabled, false otherwise", - "name": "requireshvm", - "type": "boolean" - }, {}, { - "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", - "name": "directdownload", - "type": "boolean" - }, - { - "description": "true if this template is a featured template, false otherwise", - "name": "isfeatured", - "type": "boolean" - }, - { - "description": "true if the reset password feature is enabled, false otherwise", - "name": "passwordenabled", + "description": "true if template is sshkey enabled, false otherwise", + "name": "sshkeyenabled", "type": "boolean" }, { - "description": "the physical size of the template", - "name": "physicalsize", + "description": "the size of the template", + "name": "size", "type": "long" }, { - "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 template ID", - "name": "id", + "description": "the name of the OS type for this template.", + "name": "ostypename", "type": "string" }, { - "description": "the name of the secondary storage host for the template", - "name": "hostname", + "description": "the URL which the template/iso is registered from", + "name": "url", "type": "string" }, { - "description": "true if the template is extractable, false otherwise", - "name": "isextractable", - "type": "boolean" - }, - { - "description": "if Datadisk template, then id of the root disk template this template belongs to", - "name": "parenttemplateid", + "description": "the tag of this template", + "name": "templatetag", "type": "string" }, { - "description": "the template name", - "name": "name", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "the ID of the OS type for this template.", @@ -54369,42 +55696,52 @@ "type": "string" }, { - "description": "the project name of the template", - "name": "project", - "type": "string" + "description": "the physical size of the template", + "name": "physicalsize", + "type": "long" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "true if this template is a featured template, false otherwise", + "name": "isfeatured", + "type": "boolean" + }, + { + "description": "true if the template is extractable, false otherwise", + "name": "isextractable", "type": "boolean" }, + { + "description": "VMware only: additional key/value details tied with deploy-as-is template", + "name": "deployasisdetails", + "type": "map" + }, { "description": "the list of resource tags associated", "name": "tags", "response": [ { - "description": "the account associated with the tag", - "name": "account", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the 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": "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": "customer associated with the tag", + "name": "customer", "type": "string" }, { @@ -54413,83 +55750,117 @@ "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" } ], "type": "set" }, { - "description": "the ID of the zone for this template", - "name": "zoneid", + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", + "name": "isdynamicallyscalable", + "type": "boolean" + }, + { + "description": "if root disk template, then ids of the datas disk templates this template owns", + "name": "childtemplates", + "type": "set" + }, + { + "description": "true if the template is ready to be deployed from, false otherwise.", + "name": "isready", + "type": "boolean" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the template display text", - "name": "displaytext", + "description": "the name of the domain to which the template belongs", + "name": "domain", "type": "string" }, { - "description": "true if the template is managed across all Zones, false otherwise", - "name": "crossZones", - "type": "boolean" + "description": "additional key/value details tied with template", + "name": "details", + "type": "map" }, { - "description": "the format of the template.", - "name": "format", - "type": "imageformat" + "description": "if Datadisk template, then id of the root disk template this template belongs to", + "name": "parenttemplateid", + "type": "string" }, { - "description": "the ID of the secondary storage host for the template", - "name": "hostid", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, + { + "description": "the account id to which the template belongs", + "name": "accountid", + "type": "string" + }, + { + "description": "Lists the download progress of a template across all secondary storages", + "name": "downloaddetails", + "type": "list" + }, + { + "description": "the processor bit size", + "name": "bits", + "type": "int" + }, { "description": "checksum of the template", "name": "checksum", "type": "string" }, { - "description": "the type of the template", - "name": "templatetype", + "description": "the template ID", + "name": "id", "type": "string" }, { - "description": "the tag of this template", - "name": "templatetag", + "description": "the ID of the secondary storage host for the template", + "name": "hostid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the name of the secondary storage host for the template", + "name": "hostname", "type": "string" }, - {}, { - "description": "the date this template was created", - "name": "created", - "type": "date" + "description": "the template name", + "name": "name", + "type": "string" }, { - "description": "the date this template was removed", - "name": "removed", - "type": "date" + "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", @@ -54497,38 +55868,48 @@ "type": "string" }, { - "description": "the account name to which the template belongs", - "name": "account", - "type": "string" + "description": "true if the ISO is bootable, false otherwise", + "name": "bootable", + "type": "boolean" }, { - "description": "VMware only: additional key/value details tied with deploy-as-is template", - "name": "deployasisdetails", - "type": "map" + "description": "the date this template was removed", + "name": "removed", + "type": "date" }, { - "description": "the account id to which the template belongs", - "name": "accountid", + "description": "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 display text", + "name": "displaytext", "type": "string" }, { - "description": "additional key/value details tied with template", - "name": "details", - "type": "map" + "description": "the type of the template", + "name": "templatetype", + "type": "string" }, { - "description": "true if template is sshkey enabled, false otherwise", - "name": "sshkeyenabled", + "description": "true if template requires HVM enabled, false otherwise", + "name": "requireshvm", "type": "boolean" }, { - "description": "the URL which the template/iso is registered from", - "name": "url", + "description": "the project name of the template", + "name": "project", "type": "string" }, { - "description": "true if the ISO is bootable, false otherwise", - "name": "bootable", + "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" }, { @@ -54537,96 +55918,151 @@ "type": "string" }, { - "description": "the status of the template", - "name": "status", - "type": "string" + "description": "true if the reset password feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" }, { - "description": "the processor bit size", - "name": "bits", - "type": "int" + "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", + "name": "directdownload", + "type": "boolean" }, { - "description": "true if the template is ready to be deployed from, false otherwise.", - "name": "isready", + "description": "the date this template was created", + "name": "created", + "type": "date" + }, + { + "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 account name to which the template belongs", + "name": "account", + "type": "string" + }, + { + "description": "the status of the template", + "name": "status", + "type": "string" + } + ] + }, + { + "description": "list baremetal rack configuration", + "isasync": false, + "name": "listBaremetalRct", + "params": [ + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" }, { - "description": "the name of the OS type for this template.", - "name": "ostypename", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "the name of the domain to which the template belongs", - "name": "domain", + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + } + ], + "related": "addBaremetalRct", + "response": [ + {}, + { + "description": "id of rct", + "name": "id", "type": "string" }, { - "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", - "name": "isdynamicallyscalable", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the size of the template", - "name": "size", - "type": "long" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the ID of the domain to which the template belongs", - "name": "domainid", + "description": "url", + "name": "url", "type": "string" }, - { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - } + {} ] }, { - "description": "Restores an existing stopped or deleted VM using a VM backup", + "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": "restoreBackup", + "name": "uploadCustomCertificate", "params": [ { - "description": "ID of the backup", + "description": "DNS domain suffix that the certificate is granted for.", "length": 255, - "name": "id", - "related": "updateBackupSchedule", + "name": "domainsuffix", "required": true, - "type": "uuid" - } - ], - "response": [ + "type": "string" + }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "The certificate to be uploaded.", + "length": 65535, + "name": "certificate", + "required": true, "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "A name / alias for the certificate.", + "length": 255, + "name": "name", + "required": false, "type": "string" }, - {}, + { + "description": "The private key for the attached certificate.", + "length": 65535, + "name": "privatekey", + "required": false, + "type": "string" + }, + { + "description": "An integer providing the location in a chain that the certificate will hold. Usually, this can be left empty. When creating a chain, the top level certificate should have an ID of 1, with each step in the chain incrementing by one. Example, CA with id = 1, Intermediate CA with id = 2, Site certificate with ID = 3", + "length": 255, + "name": "id", + "required": false, + "type": "integer" + } + ], + "related": "", + "response": [ { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + {}, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "message of the certificate upload operation", + "name": "message", + "type": "string" }, - {} - ], - "since": "4.14.0" + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + } + ] }, { "description": "Lists dedicated clusters.", @@ -54641,20 +56077,6 @@ "required": false, "type": "uuid" }, - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - }, - { - "description": "the name of the account associated with the cluster. Must be used with domainId.", - "length": 255, - "name": "account", - "required": false, - "type": "string" - }, { "description": "", "length": 255, @@ -54663,18 +56085,18 @@ "type": "integer" }, { - "description": "list dedicated clusters by affinity group", + "description": "the ID of the cluster", "length": 255, - "name": "affinitygroupid", - "related": "", + "name": "clusterid", + "related": "addCluster,updateCluster", "required": false, "type": "uuid" }, { - "description": "the ID of the cluster", + "description": "list dedicated clusters by affinity group", "length": 255, - "name": "clusterid", - "related": "addCluster,updateCluster", + "name": "affinitygroupid", + "related": "", "required": false, "type": "uuid" }, @@ -54684,21 +56106,34 @@ "name": "pagesize", "required": false, "type": "integer" + }, + { + "description": "the name of the account associated with the cluster. Must be used with domainId.", + "length": 255, + "name": "account", + "required": false, + "type": "string" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" } ], "related": "", "response": [ { - "description": "the Dedication Affinity Group ID of the cluster", - "name": "affinitygroupid", + "description": "the name of the cluster", + "name": "clustername", "type": "string" }, { - "description": "the ID of the cluster", - "name": "clusterid", + "description": "the domain ID of the cluster", + "name": "domainid", "type": "string" }, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", @@ -54710,88 +56145,27 @@ "type": "string" }, { - "description": "the domain ID of the cluster", - "name": "domainid", + "description": "the Dedication Affinity Group ID of the cluster", + "name": "affinitygroupid", "type": "string" }, + {}, + {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the ID of the cluster", + "name": "clusterid", + "type": "string" }, { "description": "the Account ID of the cluster", "name": "accountid", "type": "string" }, - { - "description": "the name of the cluster", - "name": "clustername", - "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": "A name / alias for the certificate.", - "length": 255, - "name": "name", - "required": false, - "type": "string" - }, - { - "description": "The private key for the attached certificate.", - "length": 65535, - "name": "privatekey", - "required": false, - "type": "string" - }, - { - "description": "The certificate to be uploaded.", - "length": 65535, - "name": "certificate", - "required": true, - "type": "string" - }, - { - "description": "DNS domain suffix that the certificate is granted for.", - "length": 255, - "name": "domainsuffix", - "required": true, - "type": "string" - }, - { - "description": "An integer providing the location in a chain that the certificate will hold. Usually, this can be left empty. When creating a chain, the top level certificate should have an ID of 1, with each step in the chain incrementing by one. Example, CA with id = 1, Intermediate CA with id = 2, Site certificate with ID = 3", - "length": 255, - "name": "id", - "required": false, - "type": "integer" - } - ], - "related": "", - "response": [ - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - }, - { - "description": "message of the certificate upload operation", - "name": "message", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - {} + } ] }, { @@ -54810,10 +56184,11 @@ "related": "", "response": [ { - "description": "the CA service provider name", - "name": "name", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", @@ -54824,13 +56199,12 @@ "name": "description", "type": "string" }, - {}, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the CA service provider name", + "name": "name", "type": "string" - } + }, + {} ], "since": "4.11.0" }, @@ -54849,27 +56223,27 @@ } ], "response": [ - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - }, - {}, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" + }, + {}, + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" } ] }, @@ -54879,80 +56253,78 @@ "name": "listPortForwardingRules", "params": [ { - "description": "", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "page", + "name": "listall", "required": false, - "type": "integer" + "type": "boolean" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false", + "description": "", "length": 255, - "name": "listall", + "name": "page", "required": false, - "type": "boolean" + "type": "integer" }, { - "description": "List resources by tags (key/value pairs)", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "tags", + "name": "projectid", + "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", "required": false, - "type": "map" + "type": "uuid" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "Lists rule with the specified ID.", "length": 255, - "name": "isrecursive", + "name": "id", + "related": "updateIpv6FirewallRule,listPortForwardingRules,updatePortForwardingRule", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "List by keyword", "length": 255, - "name": "account", + "name": "keyword", "required": false, "type": "string" }, { - "description": "list objects by project", + "description": "", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "description": "list port forwarding rules for certain network", "length": 255, - "name": "fordisplay", + "name": "networkid", + "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listSrxFirewallNetworks,listBrocadeVcsDeviceNetworks", "required": false, - "since": "4.4", - "type": "boolean" + "since": "4.3", + "type": "uuid" }, { - "description": "list only resources belonging to the domain specified", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", + "name": "isrecursive", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "Lists rule with the specified ID.", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "id", - "related": "listPortForwardingRules,updatePortForwardingRule", + "name": "account", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "list port forwarding rules for certain network", + "description": "List resources by tags (key/value pairs)", "length": 255, - "name": "networkid", - "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listF5LoadBalancerNetworks,listNetscalerLoadBalancerNetworks,listSrxFirewallNetworks,listBrocadeVcsDeviceNetworks", + "name": "tags", "required": false, - "since": "4.3", - "type": "uuid" + "type": "map" }, { "description": "the ID of IP address of the port forwarding services", @@ -54963,79 +56335,76 @@ "type": "uuid" }, { - "description": "List by keyword", + "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", "length": 255, - "name": "keyword", + "name": "fordisplay", "required": false, - "type": "string" + "since": "4.4", + "type": "boolean" }, { - "description": "", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "pagesize", + "name": "domainid", + "related": "listDomainChildren,listDomains", "required": false, - "type": "integer" + "type": "uuid" } ], - "related": "updatePortForwardingRule", + "related": "updateIpv6FirewallRule,updatePortForwardingRule", "response": [ { - "description": "the vm ip address for the port forwarding rule", - "name": "vmguestip", + "description": "the VM name for the port forwarding rule", + "name": "virtualmachinename", "type": "string" }, { - "description": "is firewall for display to the regular user", - "name": "fordisplay", - "type": "boolean" - }, - { - "description": "the VM ID for the port forwarding rule", - "name": "virtualmachineid", + "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": "is firewall for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, { - "description": "the ID of the port forwarding rule", - "name": "id", + "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 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", + "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 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" }, { @@ -55044,88 +56413,93 @@ "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { "description": "tag value", "name": "value", "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" } ], "type": "list" }, { - "description": "the starting port of port forwarding rule's private port range", - "name": "privateport", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {}, { - "description": "the ending port of port forwarding rule's private port range", - "name": "privateendport", + "description": "the vm ip address for the port forwarding rule", + "name": "vmguestip", "type": "string" }, { - "description": "the public ip address id for the port forwarding rule", - "name": "ipaddressid", + "description": "the state of the rule", + "name": "state", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the ending port of port forwarding rule's private port range", + "name": "privateendport", "type": "string" }, - {}, { - "description": "the id of the guest network the port forwarding rule belongs to", - "name": "networkid", + "description": "the ending port of port forwarding rule's private port range", + "name": "publicendport", "type": "string" }, { - "description": "the public ip address for the port forwarding rule", - "name": "ipaddress", + "description": "the starting port of port forwarding rule's public port range", + "name": "publicport", "type": "string" }, + {}, + {}, { - "description": "the VM display name for the port forwarding rule", - "name": "virtualmachinedisplayname", + "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", "type": "string" }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "the protocol of the port forwarding rule", "name": "protocol", "type": "string" }, { - "description": "the VM name for the port forwarding rule", - "name": "virtualmachinename", + "description": "the id of the guest network the port forwarding rule belongs to", + "name": "networkid", "type": "string" }, { - "description": "the state of the rule", - "name": "state", + "description": "the public ip address for the port forwarding rule", + "name": "ipaddress", "type": "string" }, { - "description": "the starting port of port forwarding rule's public port range", - "name": "publicport", + "description": "the VM display name for the port forwarding rule", + "name": "virtualmachinedisplayname", "type": "string" }, { - "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", + "description": "the 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" } ] @@ -55155,44 +56529,40 @@ "related": "", "response": [ { - "description": "Gateway for Pod ", - "name": "gateway", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the ID of the pod the IP address", - "name": "id", - "type": "long" + "description": "Gateway for Pod ", + "name": "gateway", + "type": "string" }, + {}, { "description": "the ID of the nic", "name": "nicid", "type": "long" }, { - "description": "CIDR of the Pod", - "name": "cidr", - "type": "string" + "description": "MAC address of the pod the IP", + "name": "hostmac", + "type": "long" }, { "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 current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the ID of the pod the IP address", + "name": "id", + "type": "long" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "CIDR of the Pod", + "name": "cidr", "type": "string" }, { @@ -55200,7 +56570,11 @@ "name": "ipaddress", "type": "string" }, - {} + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } ] }, { @@ -55219,24 +56593,36 @@ ], "related": "enableOutOfBandManagementForHost,disableOutOfBandManagementForHost,disableOutOfBandManagementForCluster", "response": [ + { + "description": "the out-of-band management interface username", + "name": "username", + "type": "string" + }, + { + "description": "the ID of the host", + "name": "hostid", + "type": "string" + }, { "description": "the operation result", "name": "status", "type": "boolean" }, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the out-of-band management action (if issued)", + "name": "action", "type": "string" }, + {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "true if out-of-band management is enabled for the host", + "name": "enabled", + "type": "boolean" }, { - "description": "the out-of-band management driver for the host", - "name": "driver", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -55244,15 +56630,9 @@ "name": "password", "type": "string" }, - {}, - { - "description": "the ID of the host", - "name": "hostid", - "type": "string" - }, { - "description": "the out-of-band management interface address", - "name": "address", + "description": "the out-of-band management driver for the host", + "name": "driver", "type": "string" }, { @@ -55266,9 +56646,9 @@ "type": "powerstate" }, { - "description": "the out-of-band management interface username", - "name": "username", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "the out-of-band management interface port", @@ -55276,14 +56656,8 @@ "type": "string" }, { - "description": "true if out-of-band management is enabled for the host", - "name": "enabled", - "type": "boolean" - }, - {}, - { - "description": "the out-of-band management action (if issued)", - "name": "action", + "description": "the out-of-band management interface address", + "name": "address", "type": "string" } ], @@ -55295,18 +56669,19 @@ "name": "updateTemplatePermissions", "params": [ { - "description": "true for featured template/iso, false otherwise", + "description": "the template ID", "length": 255, - "name": "isfeatured", - "required": false, - "type": "boolean" + "name": "id", + "related": "listIsos,registerIso,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", + "required": true, + "type": "uuid" }, { - "description": "a comma delimited list of accounts within caller's domain. If specified, \"op\" parameter has to be passed in.", + "description": "true for featured template/iso, false otherwise", "length": 255, - "name": "accounts", + "name": "isfeatured", "required": false, - "type": "list" + "type": "boolean" }, { "description": "true if the template/iso is extractable, false other wise. Can be set only by root admin", @@ -55322,6 +56697,14 @@ "required": false, "type": "boolean" }, + { + "description": "a comma delimited list of projects. If specified, \"op\" parameter has to be passed in.", + "length": 255, + "name": "projectids", + "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", + "required": false, + "type": "list" + }, { "description": "permission operator (add, remove, reset)", "length": 255, @@ -55330,20 +56713,11 @@ "type": "string" }, { - "description": "a comma delimited list of projects. If specified, \"op\" parameter has to be passed in.", + "description": "a comma delimited list of accounts within caller's domain. If specified, \"op\" parameter has to be passed in.", "length": 255, - "name": "projectids", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", + "name": "accounts", "required": false, "type": "list" - }, - { - "description": "the template ID", - "length": 255, - "name": "id", - "related": "listIsos,registerIso,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", - "required": true, - "type": "uuid" } ], "response": [ @@ -55353,21 +56727,21 @@ "type": "string" }, {}, - {}, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ] }, @@ -55383,6 +56757,13 @@ "required": false, "type": "string" }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, { "description": "", "length": 255, @@ -55397,27 +56778,10 @@ "related": "createZone,updateZone,listZones,listZones", "required": true, "type": "uuid" - }, - { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" } ], "related": "addTrafficMonitor", "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 number of times to retry requests to the external firewall", "name": "numretries", @@ -55429,465 +56793,93 @@ "type": "string" }, { - "description": "the management IP address of the external firewall", - "name": "ipaddress", - "type": "string" - }, - { - "description": "the timeout (in seconds) for requests to the external firewall", - "name": "timeout", - "type": "string" - }, - {}, - {}, - { - "description": "the ID of the external firewall", - "name": "id", - "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": "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 this virtual machine is running with", - "name": "cpunumber", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", - "type": "string" - }, - { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", - "type": "string" - }, - {}, - { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", - "type": "string" - }, - { - "description": "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 ID of the availablility zone for the virtual machine", - "name": "zoneid", - "type": "string" - }, - { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", - "type": "boolean" - }, - { - "description": "the account associated with the virtual machine", - "name": "account", - "type": "string" - }, - { - "description": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" - }, - { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" - }, - { - "description": "the 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": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", - "type": "string" - }, - { - "description": "the vgpu type used by the virtual machine", - "name": "vgpu", - "type": "string" - }, - { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", - "type": "string" - }, - { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", - "type": "string" - }, - { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - {}, - { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" - }, - { - "description": "the name of the disk offering of the virtual machine", - "name": "diskofferingname", - "type": "string" - }, - { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", - "type": "string" - }, - { - "description": "device type of the root volume", - "name": "rootdevicetype", - "type": "string" - }, - { - "description": "the ID of the host for the virtual machine", - "name": "hostid", - "type": "string" - }, - { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" - }, - { - "description": "OS name of the vm", - "name": "osdisplayname", - "type": "string" - }, - { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" - }, - { - "description": "ssh key-pair", - "name": "keypair", - "type": "string" - }, - { - "description": "the project name of the vm", - "name": "project", - "type": "string" - }, - { - "description": "the ID of the disk offering of the virtual machine", - "name": "diskofferingid", - "type": "string" - }, - { - "description": "the password (if exists) of the virtual machine", - "name": "password", - "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": "the target memory in vm", - "name": "memorytargetkbs", - "type": "long" - }, - { - "description": "the list of nics associated with vm", - "name": "nic", - "response": [ - { - "description": "the ID of the corresponding network", - "name": "networkid", - "type": "string" - }, - { - "description": "the isolation uri of the nic", - "name": "isolationuri", - "type": "string" - }, - { - "description": "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 IPv6 address of network", - "name": "ip6address", - "type": "string" - }, - { - "description": "the traffic type of the nic", - "name": "traffictype", - "type": "string" - }, - { - "description": "true if nic is default, false otherwise", - "name": "macaddress", - "type": "string" - }, - { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "the ip address of the nic", - "name": "ipaddress", - "type": "string" - }, - { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - }, - { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "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": "Type of adapter if available", - "name": "adaptertype", - "type": "string" - }, - { - "description": "the netmask of the nic", - "name": "netmask", - "type": "string" - }, - { - "description": "the type of the nic", - "name": "type", - "type": "string" - }, - { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" - }, - { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", - "type": "string" - }, - { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" - }, - { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", - "type": "string" - }, - { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", - "type": "string" - }, - { - "description": "the 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" - } - ], - "type": "set" - }, - { - "description": "the write (bytes) of disk on the vm", - "name": "diskkbswrite", - "type": "long" - }, - { - "description": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", - "response": [ - { - "description": "the project ID of the affinity group", - "name": "projectid", - "type": "string" - }, - { - "description": "the project name of the affinity group", - "name": "project", - "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 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 account owning the affinity group", - "name": "account", - "type": "string" - }, - { - "description": "the description of the affinity group", - "name": "description", - "type": "string" - }, - { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" - } - ], - "type": "set" + "description": "the ID of the external firewall", + "name": "id", + "type": "string" }, + {}, { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" + "description": "the management IP address of the external firewall", + "name": "ipaddress", + "type": "string" }, + {}, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the timeout (in seconds) for requests to the external firewall", + "name": "timeout", "type": "string" + } + ] + }, + { + "description": "Resets the password for virtual machine. The virtual machine must be in a \"Stopped\" state and the template must already support this feature for this command to take effect. [async]", + "isasync": true, + "name": "resetPasswordForVirtualMachine", + "params": [ + { + "description": "The ID of the virtual machine", + "length": 255, + "name": "id", + "related": "migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,startVirtualMachine,stopVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,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": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" }, { - "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 speed of each cpu", - "name": "cpuspeed", + "description": "the memory allocated for the virtual machine", + "name": "memory", "type": "integer" }, { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", "type": "string" }, { - "description": "the name of the virtual machine", - "name": "name", + "description": "the ID of the host for the virtual machine", + "name": "hostid", "type": "string" }, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", "type": "string" }, { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", + "description": "Guest vm Boot Mode", + "name": "bootmode", + "type": "string" + }, + { + "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" }, { @@ -55899,52 +56891,57 @@ "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 number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" + }, { "description": "the ID of the security group", "name": "id", "type": "string" }, { - "description": "the project id of the group", - "name": "projectid", - "type": "string" + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" }, { - "description": "the list of ingress rules associated with the security group", - "name": "ingressrule", + "description": "the list of egress rules associated with the security group", + "name": "egressrule", "response": [ { - "description": "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", + "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 list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { @@ -55958,8 +56955,8 @@ "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { @@ -55968,8 +56965,8 @@ "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { @@ -55978,13 +56975,8 @@ "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { @@ -55996,14 +56988,14 @@ "type": "set" }, { - "description": "the protocol of the security group rule", - "name": "protocol", + "description": "the id of the security group rule", + "name": "ruleid", "type": "string" }, { - "description": "the 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", @@ -56011,18 +57003,43 @@ "type": "string" }, { - "description": "the code for the ICMP message response", - "name": "icmpcode", + "description": "the type of the ICMP message response", + "name": "icmptype", "type": "integer" }, { "description": "the ending IP of the security group rule ", "name": "endport", "type": "integer" + }, + { + "description": "account owning the security group rule", + "name": "account", + "type": "string" + }, + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" } ], "type": "set" }, + { + "description": "the name of the security group", + "name": "name", + "type": "string" + }, + { + "description": "the domain name of the security group", + "name": "domain", + "type": "string" + }, + { + "description": "the domain ID of the security group", + "name": "domainid", + "type": "string" + }, { "description": "the list of resource tags associated with the rule", "name": "tags", @@ -56033,18 +57050,8 @@ "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { @@ -56058,8 +57065,8 @@ "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { @@ -56068,8 +57075,18 @@ "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", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { @@ -56081,71 +57098,71 @@ "type": "set" }, { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" - }, - { - "description": "the domain ID of the security group", - "name": "domainid", - "type": "string" - }, - { - "description": "the description of the security group", - "name": "description", - "type": "string" - }, - { - "description": "the name of the security group", - "name": "name", + "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 list of egress rules associated with the security group", - "name": "egressrule", + "description": "the list of ingress rules associated with the security group", + "name": "ingressrule", "response": [ { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" + "description": "account owning the security group rule", + "name": "account", + "type": "string" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" }, { "description": "the type of the ICMP message response", "name": "icmptype", "type": "integer" }, + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, { "description": "the ending IP of the security group rule ", "name": "endport", "type": "integer" }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, { "description": "the CIDR notation for the base IP address of the security group rule", "name": "cidr", "type": "string" }, { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "tag value", - "name": "value", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { @@ -56154,151 +57171,406 @@ "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "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 domain associated with the tag", - "name": "domain", + "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 protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" } ], "type": "set" - }, - { - "description": "the domain name of the security group", - "name": "domain", - "type": "string" } ], "type": "set" }, { - "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", + "type": "string" + }, + { + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" + }, + { + "description": "the name of the host for the virtual machine", + "name": "hostname", + "type": "string" + }, + { + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" + }, + { + "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 name of the ISO attached to the virtual machine", + "name": "isoname", + "type": "string" + }, + { + "description": "the ID of the disk offering of the virtual machine", + "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": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", + "type": "string" + }, + { + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" + }, + { + "description": "device type of the root volume", + "name": "rootdevicetype", + "type": "string" + }, + { + "description": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" + }, + { + "description": "the ID of the availablility zone for the virtual machine", + "name": "zoneid", + "type": "string" + }, + { + "description": "the memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" + }, + { + "description": "the password (if exists) of the virtual machine", + "name": "password", + "type": "string" + }, + { + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + {}, + { + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" + }, + { + "description": "OS type id of the vm", + "name": "ostypeid", + "type": "string" + }, + { + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" + }, + { + "description": "ssh key-pairs", + "name": "keypairs", + "type": "string" + }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the user's name who deployed the virtual machine", + "name": "username", + "type": "string" + }, + { + "description": "the user's ID who deployed the virtual machine", + "name": "userid", + "type": "string" + }, + { + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" + }, + { + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" + }, + {}, + { + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "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": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" + }, + { + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", + "type": "string" + }, + { + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" + }, + { + "description": "the pool type of the virtual machine", + "name": "pooltype", + "type": "string" + }, + { + "description": "the account associated with the virtual machine", + "name": "account", + "type": "string" + }, + { + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" + }, + { + "description": "the name of the virtual machine", + "name": "name", + "type": "string" + }, + { + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", + "type": "boolean" + }, + { + "description": "OS name of the vm", + "name": "osdisplayname", + "type": "string" }, { - "description": "State of the Service from LB rule", - "name": "servicestate", + "description": "the group ID of the virtual machine", + "name": "groupid", "type": "string" }, { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", "type": "string" }, { - "description": "OS type id of the vm", - "name": "ostypeid", + "description": "the project id of the vm", + "name": "projectid", "type": "string" }, { - "description": "the name of the host for the virtual machine", - "name": "hostname", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "the pool type of the virtual machine", - "name": "pooltype", + "description": "the state of the virtual machine", + "name": "state", "type": "string" }, { - "description": "the ID of the virtual machine", - "name": "id", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the project id of the vm", - "name": "projectid", + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" + }, + { + "description": "Os type ID of the virtual machine", + "name": "guestosid", "type": "string" }, { - "description": "the list of resource tags associated", - "name": "tags", + "description": "the name of the disk offering of the virtual machine", + "name": "diskofferingname", + "type": "string" + }, + { + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", + "type": "string" + }, + { + "description": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", "response": [ { - "description": "the domain associated with the tag", + "description": "the domain name of the affinity group", "name": "domain", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the type of the affinity group", + "name": "type", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the name of the affinity group", + "name": "name", "type": "string" }, { - "description": "the ID of the domain associated with the tag", + "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 ID of the affinity group", + "name": "id", + "type": "string" + }, + { + "description": "the project ID of the affinity group", + "name": "projectid", + "type": "string" + }, + { + "description": "the description of the affinity group", + "name": "description", + "type": "string" + }, + { + "description": "the domain ID of the affinity group", "name": "domainid", "type": "string" + } + ], + "type": "set" + }, + { + "description": "the name of the template for the virtual machine", + "name": "templatename", + "type": "string" + }, + { + "description": "Guest vm Boot Type", + "name": "boottype", + "type": "string" + }, + { + "description": "the ID of the virtual machine", + "name": "id", + "type": "string" + }, + { + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "tag value", + "name": "value", + "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { @@ -56312,57 +57584,42 @@ "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "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" } ], "type": "set" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" - }, - { - "description": "the incoming network traffic on the vm", - "name": "networkkbsread", - "type": "long" + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", + "type": "string" }, { - "description": "the write (io) of disk on the vm", - "name": "diskiowrite", + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", "type": "long" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the read (bytes) of disk on the vm", - "name": "diskkbsread", + "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", "type": "long" }, { - "description": "the state of the virtual machine", - "name": "state", - "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": "public IP address id associated with vm via Static nat rule", @@ -56370,48 +57627,175 @@ "type": "string" }, { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" + "description": "the list of nics associated with vm", + "name": "nic", + "response": [ + { + "description": "the name of the corresponding network", + "name": "networkname", + "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 cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + }, + { + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "the traffic type of the nic", + "name": "traffictype", + "type": "string" + }, + { + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", + "type": "string" + }, + { + "description": "the broadcast uri of the nic", + "name": "broadcasturi", + "type": "string" + }, + { + "description": "the netmask of the nic", + "name": "netmask", + "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": "the isolation uri of the nic", + "name": "isolationuri", + "type": "string" + }, + { + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" + }, + { + "description": "the type of the nic", + "name": "type", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "macaddress", + "type": "string" + }, + { + "description": "the ip address of the nic", + "name": "ipaddress", + "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": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" + }, + { + "description": "the IPv6 address of network", + "name": "ip6address", + "type": "string" + }, + { + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", + "type": "string" + }, + { + "description": "the ID of the corresponding network", + "name": "networkid", + "type": "string" + }, + { + "description": "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": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" + }, + { + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", + "type": "string" + } + ], + "type": "set" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", "type": "string" }, { - "description": "the memory used by the vm", - "name": "memorykbs", + "description": "the read (IO) of disk on the VM", + "name": "diskioread", "type": "long" }, - { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", - "type": "string" - }, - { - "description": "the group name of the virtual machine", - "name": "group", - "type": "string" - }, { "description": "the ID of the service offering of the virtual machine", "name": "serviceofferingid", "type": "string" }, { - "description": "the internal memory that's free in vm or zero if it can not be calculated", - "name": "memoryintfreekbs", - "type": "long" - }, - { - "description": "the group ID of the virtual machine", - "name": "groupid", - "type": "string" + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", "type": "string" } ] @@ -56422,13 +57806,12 @@ "name": "updatePortForwardingRule", "params": [ { - "description": "the ID of the port forwarding rule", + "description": "VM guest nic Secondary ip address for the port forwarding rule", "length": 255, - "name": "id", - "related": "updatePortForwardingRule", - "required": true, - "since": "4.4", - "type": "uuid" + "name": "vmguestip", + "required": false, + "since": "4.5", + "type": "string" }, { "description": "the private end port of the port forwarding rule", @@ -56438,11 +57821,20 @@ "type": "integer" }, { - "description": "the ID of the virtual machine for the port forwarding rule", + "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", "length": 255, - "name": "virtualmachineid", - "related": "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": "customid", "required": false, + "since": "4.4", + "type": "string" + }, + { + "description": "the ID of the port forwarding rule", + "length": 255, + "name": "id", + "related": "updateIpv6FirewallRule,updatePortForwardingRule", + "required": true, + "since": "4.4", "type": "uuid" }, { @@ -56454,94 +57846,61 @@ "type": "boolean" }, { - "description": "the private start port of the port forwarding rule", - "length": 255, - "name": "privateport", - "required": false, - "type": "integer" - }, - { - "description": "VM guest nic Secondary ip address for the port forwarding rule", + "description": "the ID of the virtual machine for the port forwarding rule", "length": 255, - "name": "vmguestip", + "name": "virtualmachineid", + "related": "migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,startVirtualMachine,stopVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance", "required": false, - "since": "4.5", - "type": "string" + "type": "uuid" }, { - "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", + "description": "the private start port of the port forwarding rule", "length": 255, - "name": "customid", + "name": "privateport", "required": false, - "since": "4.4", - "type": "string" + "type": "integer" } ], - "related": "", + "related": "updateIpv6FirewallRule", "response": [ - { - "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", - "type": "string" - }, { "description": "the vm ip address for the port forwarding rule", "name": "vmguestip", "type": "string" }, { - "description": "the public ip address id for the port forwarding rule", - "name": "ipaddressid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, { "description": "the VM ID for the port forwarding rule", "name": "virtualmachineid", "type": "string" }, - {}, - { - "description": "the public ip address for the port forwarding rule", - "name": "ipaddress", - "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": "privateendport", - "type": "string" - }, { - "description": "the id of the guest network the port forwarding rule belongs to", - "name": "networkid", + "description": "the VM name for the port forwarding rule", + "name": "virtualmachinename", "type": "string" }, { - "description": "the starting port of port forwarding rule's public port range", - "name": "publicport", + "description": "the protocol of the port forwarding rule", + "name": "protocol", "type": "string" }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "tag key name", - "name": "key", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { @@ -56550,28 +57909,28 @@ "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { @@ -56580,53 +57939,78 @@ "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "tag key name", + "name": "key", "type": "string" } ], "type": "list" }, + { + "description": "the id of the guest network the port forwarding rule belongs to", + "name": "networkid", + "type": "string" + }, + { + "description": "the state of the rule", + "name": "state", + "type": "string" + }, + { + "description": "the starting port of port forwarding rule's public port range", + "name": "publicport", + "type": "string" + }, {}, { - "description": "the ending port of port forwarding rule's private port range", - "name": "publicendport", + "description": "the starting port of port forwarding rule's private port range", + "name": "privateport", "type": "string" }, { - "description": "the VM name for the port forwarding rule", - "name": "virtualmachinename", + "description": "the ending port of port forwarding rule's private port range", + "name": "publicendport", "type": "string" }, { - "description": "the state of the rule", - "name": "state", + "description": "the 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", + "description": "the public ip address id for the port forwarding rule", + "name": "ipaddressid", "type": "string" }, { - "description": "the ID of the port forwarding rule", - "name": "id", + "description": "the public ip address for the port forwarding rule", + "name": "ipaddress", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the 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 ending port of port forwarding rule's private port range", + "name": "privateendport", + "type": "string" + }, { "description": "is firewall for display to the regular user", "name": "fordisplay", "type": "boolean" + }, + { + "description": "the ID of the port forwarding rule", + "name": "id", + "type": "string" } ] }, @@ -56636,18 +58020,12 @@ "name": "listBrocadeVcsDevices", "params": [ { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, - { - "description": "List by keyword", + "description": "Brocade VCS switch ID", "length": 255, - "name": "keyword", + "name": "vcsdeviceid", + "related": "listBrocadeVcsDevices", "required": false, - "type": "string" + "type": "uuid" }, { "description": "", @@ -56657,59 +58035,65 @@ "type": "integer" }, { - "description": "Brocade VCS switch ID", + "description": "the Physical Network ID", "length": 255, - "name": "vcsdeviceid", - "related": "listBrocadeVcsDevices", + "name": "physicalnetworkid", + "related": "createPhysicalNetwork", "required": false, "type": "uuid" }, { - "description": "the Physical Network ID", + "description": "", "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" } ], "related": "", "response": [ - {}, { - "description": "device name", - "name": "brocadedevicename", + "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 principal switch Ip address", "name": "hostname", "type": "string" }, { - "description": "device id of the Brocade Vcs", - "name": "vcsdeviceid", + "description": "the physical Network to which this Brocade VCS belongs to", + "name": "physicalnetworkid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "device id of the Brocade Vcs", + "name": "vcsdeviceid", "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 Brocade VCS belongs to", - "name": "physicalnetworkid", + "description": "device name", + "name": "brocadedevicename", "type": "string" }, + {}, + {}, { - "description": "name of the provider", - "name": "provider", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" } ] @@ -56720,16 +58104,9 @@ "name": "linkDomainToLdap", "params": [ { - "description": "Type of the account to auto import. Specify 0 for user and 2 for domain admin", - "length": 255, - "name": "accounttype", - "required": true, - "type": "short" - }, - { - "description": "name of the group or OU in LDAP", + "description": "domain admin username in LDAP ", "length": 255, - "name": "ldapdomain", + "name": "admin", "required": false, "type": "string" }, @@ -56756,34 +58133,42 @@ "type": "string" }, { - "description": "domain admin username in LDAP ", + "description": "name of the group or OU in LDAP", "length": 255, - "name": "admin", + "name": "ldapdomain", "required": false, "type": "string" + }, + { + "description": "Type of the account to auto import. Specify 0 for user and 2 for domain admin", + "length": 255, + "name": "accounttype", + "required": true, + "type": "integer" } ], "related": "linkAccountToLdap", "response": [ + {}, + {}, { - "description": "type of the name in LDAP which is linke to the domain", - "name": "type", + "description": "the UUID of the latest async job acting on 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 Domain which is linked to LDAP", + "name": "domainid", + "type": "string" }, - {}, { - "description": "name of the group or OU in LDAP which is linked to the domain", - "name": "name", + "description": "Domain Admin accountId that is created", + "name": "accountid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "name of the group or OU in LDAP which is linked to the domain", + "name": "name", "type": "string" }, { @@ -56791,20 +58176,19 @@ "name": "ldapdomain", "type": "string" }, - {}, { "description": "Type of the account to auto import", "name": "accounttype", - "type": "short" + "type": "int" }, { - "description": "Domain Admin accountId that is created", - "name": "accountid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "id of the Domain which is linked to LDAP", - "name": "domainid", + "description": "type of the name in LDAP which is linke to the domain", + "name": "type", "type": "string" } ], @@ -56824,25 +58208,18 @@ "type": "uuid" }, { - "description": "IP Address to be associated", - "length": 255, - "name": "ipaddress", - "required": false, - "type": "string" - }, - { - "description": "the ID of the availability zone you want to acquire an public IP address from", + "description": "Deploy VM for the project", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "projectid", + "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", "required": false, "type": "uuid" }, { - "description": "the ID of the domain to associate with this IP address", + "description": "The network this IP address should be associated to.", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", + "name": "networkid", + "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listSrxFirewallNetworks,listBrocadeVcsDeviceNetworks", "required": false, "type": "uuid" }, @@ -56853,14 +58230,6 @@ "required": false, "type": "boolean" }, - { - "description": "an optional field, whether to the display the IP to the end user or not", - "length": 255, - "name": "fordisplay", - "required": false, - "since": "4.4", - "type": "boolean" - }, { "description": "region ID from where portable IP is to be associated.", "length": 255, @@ -56870,49 +58239,59 @@ "type": "integer" }, { - "description": "The network this IP address should be associated to.", + "description": "the ID of the availability zone you want to acquire an public IP address from", "length": 255, - "name": "networkid", - "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listF5LoadBalancerNetworks,listNetscalerLoadBalancerNetworks,listSrxFirewallNetworks,listBrocadeVcsDeviceNetworks", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, "type": "uuid" }, { - "description": "Deploy VM for the project", + "description": "the account to associate with this IP address", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", + "name": "account", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "the account to associate with this IP address", + "description": "IP Address to be associated", "length": 255, - "name": "account", + "name": "ipaddress", "required": false, "type": "string" + }, + { + "description": "an optional field, whether to the display the IP to the end user or not", + "length": 255, + "name": "fordisplay", + "required": false, + "since": "4.4", + "type": "boolean" + }, + { + "description": "the ID of the domain to associate with this IP address", + "length": 255, + "name": "domainid", + "related": "listDomainChildren,listDomains", + "required": false, + "type": "uuid" } ], "related": "updateIpAddress,associateIpAddress,listPublicIpAddresses", "response": [ { - "description": "virtual machine name the ip address is assigned to (not null only for static nat Ip)", - "name": "virtualmachinename", - "type": "string" - }, - { - "description": "public IP address id", - "name": "id", + "description": "the ID of the VLAN associated with the IP address. This parameter is visible to ROOT admins only", + "name": "vlanid", "type": "string" }, { - "description": "the name of the Network associated with the IP address", - "name": "associatednetworkname", + "description": "the project name of the address", + "name": "project", "type": "string" }, { - "description": "the virtual network for the IP address", - "name": "forvirtualnetwork", + "description": "is public ip for display to the regular user", + "name": "fordisplay", "type": "boolean" }, { @@ -56920,91 +58299,101 @@ "name": "tags", "response": [ { - "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": "customer associated with the tag", - "name": "customer", + "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 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": "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 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" }, { - "description": "tag value", - "name": "value", + "description": "tag key name", + "name": "key", "type": "string" } ], "type": "list" }, { - "description": "the ID of the zone the public IP address belongs to", - "name": "zoneid", + "description": "VPC id the ip belongs to", + "name": "vpcid", "type": "string" }, { - "description": "State of the ip address. Can be: Allocatin, Allocated and Releasing", - "name": "state", + "description": "the project id of the ipaddress", + "name": "projectid", "type": "string" }, { - "description": "VPC name the ip belongs to", - "name": "vpcname", + "description": "virtual machine (dnat) ip address (not null only for static nat Ip)", + "name": "vmipaddress", "type": "string" }, { - "description": "public IP address", - "name": "ipaddress", + "description": "virtual machine display name the ip address is assigned to (not null only for static nat Ip)", + "name": "virtualmachinedisplayname", "type": "string" }, { - "description": "the VLAN associated with the IP address", - "name": "vlanname", + "description": "the account the public IP address is associated with", + "name": "account", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "VPC name the ip belongs to", + "name": "vpcname", "type": "string" }, { - "description": "the ID of the Network associated with the IP address", - "name": "associatednetworkid", + "description": "the domain ID the public IP address is associated with", + "name": "domainid", + "type": "string" + }, + { + "description": "public IP address", + "name": "ipaddress", + "type": "string" + }, + { + "description": "State of the ip address. Can be: Allocatin, Allocated and Releasing", + "name": "state", "type": "string" }, { @@ -57013,66 +58402,60 @@ "type": "boolean" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the name of the Network where ip belongs to", + "name": "networkname", + "type": "string" }, { - "description": "the project name of the address", - "name": "project", - "type": "string" + "description": "is public IP portable across the zones", + "name": "isportable", + "type": "boolean" }, { - "description": "virtual machine display name the ip address is assigned to (not null only for static nat Ip)", - "name": "virtualmachinedisplayname", + "description": "the VLAN associated with the IP address", + "name": "vlanname", "type": "string" }, { - "description": "the domain the public IP address is associated with", - "name": "domain", + "description": "purpose of the IP address. In Acton this value is not null for Ips with isSystem=true, and can have either StaticNat or LB value", + "name": "purpose", "type": "string" }, { - "description": "the ID of the Network where ip belongs to", - "name": "networkid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {}, { - "description": "date the public IP address was acquired", - "name": "allocated", - "type": "date" + "description": "virtual machine id the ip address is assigned to (not null only for static nat Ip)", + "name": "virtualmachineid", + "type": "string" }, + {}, { "description": "the physical network this belongs to", "name": "physicalnetworkid", "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": "VPC id the ip belongs to", - "name": "vpcid", + "description": "public IP address id", + "name": "id", "type": "string" }, { - "description": "the domain ID the public IP address is associated with", - "name": "domainid", + "description": "the domain the public IP address is associated with", + "name": "domain", "type": "string" }, { - "description": "virtual machine (dnat) ip address (not null only for static nat Ip)", - "name": "vmipaddress", + "description": "the ID of the Network where ip belongs to", + "name": "networkid", "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 current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "true if the IP address is a source nat address, false otherwise", @@ -57080,34 +58463,35 @@ "type": "boolean" }, { - "description": "the project id of the ipaddress", - "name": "projectid", - "type": "string" + "description": "date the public IP address was acquired", + "name": "allocated", + "type": "date" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "the virtual network for the IP address", + "name": "forvirtualnetwork", "type": "boolean" }, + {}, { - "description": "virtual machine id the ip address is assigned to (not null only for static nat Ip)", - "name": "virtualmachineid", + "description": "the ID of the zone the public IP address belongs to", + "name": "zoneid", "type": "string" }, { - "description": "the name of the Network where ip belongs to", - "name": "networkname", + "description": "the name of the Network associated with the IP address", + "name": "associatednetworkname", "type": "string" }, { - "description": "the account the public IP address is associated with", - "name": "account", + "description": "the ID of the Network associated with the IP address", + "name": "associatednetworkid", "type": "string" }, { - "description": "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": "true if this ip is system ip (was allocated as a part of deployVm or createLbRule)", @@ -57115,14 +58499,14 @@ "type": "boolean" }, { - "description": "is public ip for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "virtual machine name the ip address is assigned to (not null only for static nat Ip)", + "name": "virtualmachinename", + "type": "string" }, { - "description": "the name of the zone the public IP address belongs to", - "name": "zonename", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" } ] }, @@ -57148,23 +58532,23 @@ ], "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": "SolidFire Volume Access Group Ids", + "name": "solidFireVolumeAccessGroupIds", + "type": "long[]" + }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - }, - {}, - {} + } ] }, { @@ -57182,62 +58566,23 @@ } ], "response": [ - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - {} - ] - }, - { - "description": " delete a F5 load balancer device", - "isasync": true, - "name": "deleteF5LoadBalancer", - "params": [ - { - "description": "netscaler load balancer device ID", - "length": 255, - "name": "lbdeviceid", - "related": "addF5LoadBalancer", - "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": "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", @@ -57251,40 +58596,33 @@ "name": "createNetworkACL", "params": [ { - "description": "the traffic type for the ACL,can be ingress or egress, defaulted to ingress if not specified", + "description": "type of the ICMP message being sent", "length": 255, - "name": "traffictype", + "name": "icmptype", "required": false, - "type": "string" + "type": "integer" }, { - "description": "The network of the VM the ACL will be created for", + "description": "scl entry action, allow or deny", "length": 255, - "name": "networkid", - "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listF5LoadBalancerNetworks,listNetscalerLoadBalancerNetworks,listSrxFirewallNetworks,listBrocadeVcsDeviceNetworks", + "name": "action", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "error code for this ICMP message", + "description": "the ending port of ACL", "length": 255, - "name": "icmpcode", + "name": "endport", "required": false, "type": "integer" }, { - "description": "the protocol for the ACL rule. Valid values are TCP/UDP/ICMP/ALL or valid protocol number", - "length": 255, - "name": "protocol", - "required": true, - "type": "string" - }, - { - "description": "the CIDR list to allow traffic from/to. Multiple entries must be separated by a single comma character (,).", + "description": "an optional field, whether to the display the rule to the end user or not", "length": 255, - "name": "cidrlist", + "name": "fordisplay", "required": false, - "type": "list" + "since": "4.4", + "type": "boolean" }, { "description": "The network of the VM the ACL will be created for", @@ -57295,12 +58633,19 @@ "type": "uuid" }, { - "description": "scl entry action, allow or deny", + "description": "the protocol for the ACL rule. Valid values are TCP/UDP/ICMP/ALL or valid protocol number", "length": 255, - "name": "action", - "required": false, + "name": "protocol", + "required": true, "type": "string" }, + { + "description": "the starting port of ACL", + "length": 255, + "name": "startport", + "required": false, + "type": "integer" + }, { "description": "A description indicating why the ACL rule is required.", "length": 255, @@ -57309,9 +58654,16 @@ "type": "string" }, { - "description": "the starting port of ACL", + "description": "the traffic type for the ACL,can be ingress or egress, defaulted to ingress if not specified", "length": 255, - "name": "startport", + "name": "traffictype", + "required": false, + "type": "string" + }, + { + "description": "error code for this ICMP message", + "length": 255, + "name": "icmpcode", "required": false, "type": "integer" }, @@ -57323,104 +58675,41 @@ "type": "integer" }, { - "description": "type of the ICMP message being sent", - "length": 255, - "name": "icmptype", - "required": false, - "type": "integer" - }, - { - "description": "the ending port of ACL", + "description": "the CIDR list to allow traffic from/to. Multiple entries must be separated by a single comma character (,).", "length": 255, - "name": "endport", + "name": "cidrlist", "required": false, - "type": "integer" + "type": "list" }, { - "description": "an optional field, whether to the display the rule to the end user or not", + "description": "The network of the VM the ACL will be created for", "length": 255, - "name": "fordisplay", + "name": "networkid", + "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listSrxFirewallNetworks,listBrocadeVcsDeviceNetworks", "required": false, - "since": "4.4", - "type": "boolean" + "type": "uuid" } ], "related": "updateNetworkACLItem,moveNetworkAclItem", "response": [ - { - "description": "error code for this icmp message", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "an explanation on why this ACL rule is being applied", - "name": "reason", - "type": "string" - }, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", - "type": "string" - }, - { - "description": "the ID of the ACL this item belongs to", - "name": "aclid", - "type": "string" - }, - { - "description": "the state of the rule", - "name": "state", - "type": "string" - }, - { - "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": "the traffic type for the ACL", - "name": "traffictype", - "type": "string" - }, - { - "description": "is rule for display to the regular user", - "name": "fordisplay", - "type": "boolean" - }, {}, { "description": "the list of resource tags associated with the network ACLs", "name": "tags", "response": [ { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "tag value", - "name": "value", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { @@ -57429,8 +58718,8 @@ "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { @@ -57438,19 +58727,24 @@ "name": "domain", "type": "string" }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, { "description": "tag key name", "name": "key", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "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" } ], @@ -57462,13 +58756,18 @@ "type": "integer" }, { - "description": "the ending port of ACL's port range", - "name": "endport", + "description": "the traffic type for the ACL", + "name": "traffictype", "type": "string" }, { - "description": "the protocol of the ACL", - "name": "protocol", + "description": "the ID of the ACL Item", + "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" }, { @@ -57476,9 +58775,15 @@ "name": "jobid", "type": "string" }, + {}, { - "description": "the ID of the ACL Item", - "name": "id", + "description": "the ID of the ACL this item belongs to", + "name": "aclid", + "type": "string" + }, + { + "description": "the ending port of ACL's port range", + "name": "endport", "type": "string" }, { @@ -57486,6 +58791,46 @@ "name": "number", "type": "integer" }, + { + "description": "error code for this icmp message", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the state of the rule", + "name": "state", + "type": "string" + }, + { + "description": "the protocol of the ACL", + "name": "protocol", + "type": "string" + }, + { + "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": "is rule for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, + { + "description": "the name of the ACL this item belongs to", + "name": "aclname", + "type": "string" + }, { "description": "Action of ACL Item. Allow/Deny", "name": "action", @@ -57499,26 +58844,19 @@ "name": "resetSSHKeyForVirtualMachine", "params": [ { - "description": "name of the ssh key pair used to login to the virtual machine", - "length": 255, - "name": "keypair", - "required": true, - "type": "string" - }, - { - "description": "an optional domainId for the virtual machine. If the account parameter is used, domainId must also be used.", + "description": "an optional account for the ssh key. Must be used with domainId.", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", + "name": "account", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "an optional account for the ssh key. Must be used with domainId.", + "description": "names of the ssh key pairs to be used to login to the virtual machine", "length": 255, - "name": "account", + "name": "keypairs", "required": false, - "type": "string" + "since": "4.17", + "type": "list" }, { "description": "The ID of the virtual machine", @@ -57535,449 +58873,221 @@ "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,importUnmanagedInstance", - "response": [ - { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" - }, - { - "description": "the ID of the host for the virtual machine", - "name": "hostid", - "type": "string" - }, - { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", - "type": "string" - }, - { - "description": "the ID of the availablility zone for the virtual machine", - "name": "zoneid", - "type": "string" - }, - { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" - }, - { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", - "type": "string" - }, - { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "the name of the virtual machine", - "name": "name", + "description": "name of the ssh key pair used to login to the virtual machine", + "length": 255, + "name": "keypair", + "required": false, "type": "string" }, { - "description": "the write (bytes) of disk on the vm", - "name": "diskkbswrite", - "type": "long" - }, + "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" + } + ], + "related": "migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,startVirtualMachine,stopVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance", + "response": [ { "description": "true if the entity/resource has annotations", "name": "hasannotations", "type": "boolean" }, { - "description": "the vgpu type used by the virtual machine", - "name": "vgpu", - "type": "string" - }, - { - "description": "the project id of the vm", - "name": "projectid", - "type": "string" - }, - {}, - { - "description": "the project name of the vm", - "name": "project", - "type": "string" - }, - { - "description": "the read (io) of disk on the vm", - "name": "diskioread", - "type": "long" - }, - { - "description": "the target memory in vm", - "name": "memorytargetkbs", - "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": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", - "type": "string" - }, - { - "description": "the list of resource tags associated", - "name": "tags", - "response": [ - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "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": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the user's name who deployed the virtual machine", - "name": "username", - "type": "string" - }, - { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", - "type": "string" - }, - { - "description": "the list of nics associated with vm", - "name": "nic", - "response": [ - { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", - "type": "string" - }, - { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "description": "the isolation uri of the nic", - "name": "isolationuri", - "type": "string" - }, - { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "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": "Type of adapter if available", - "name": "adaptertype", - "type": "string" - }, - { - "description": "true if nic is default, false otherwise", - "name": "macaddress", - "type": "string" - }, - { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "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 VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - }, - { - "description": "the ID of the nic", - "name": "id", - "type": "string" - }, - { - "description": "the netmask of the nic", - "name": "netmask", - "type": "string" - }, - { - "description": "the traffic type of the nic", - "name": "traffictype", - "type": "string" - }, - { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" - }, - { - "description": "the gateway of the nic", - "name": "gateway", - "type": "string" - }, - { - "description": "the ID of the corresponding network", - "name": "networkid", - "type": "string" - }, - { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", - "type": "string" - }, - { - "description": "the name of the corresponding network", - "name": "networkname", - "type": "string" - }, - { - "description": "the ip address of the nic", - "name": "ipaddress", - "type": "string" - }, - { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" - }, - { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", - "type": "string" - }, - { - "description": "the type of the nic", - "name": "type", - "type": "string" - }, - { - "description": "the IPv6 address of network", - "name": "ip6address", - "type": "string" - }, - { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "ssh key-pair", - "name": "keypair", + "description": "the account associated with the virtual machine", + "name": "account", "type": "string" }, { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" - }, - { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", - "type": "boolean" - }, - { - "description": "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": "the name of the host for the virtual machine", + "name": "hostname", "type": "string" }, { - "description": "the group ID of the virtual machine", - "name": "groupid", + "description": "the 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": "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", + "description": "the state of the virtual machine", + "name": "state", "type": "string" }, { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" + "description": "the user's name who deployed the virtual machine", + "name": "username", + "type": "string" }, { - "description": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", + "description": "list of security groups associated with the virtual machine", + "name": "securitygroup", "response": [ { - "description": "the project name of the affinity group", - "name": "project", - "type": "string" - }, - { - "description": "the description of the affinity group", - "name": "description", - "type": "string" + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" }, { - "description": "the account owning the affinity group", + "description": "the account owning the security group", "name": "account", "type": "string" }, { - "description": "the name of the affinity group", - "name": "name", - "type": "string" - }, - { - "description": "the ID of the affinity group", - "name": "id", + "description": "the domain name of the security group", + "name": "domain", "type": "string" }, { - "description": "the project ID of the affinity group", - "name": "projectid", - "type": "string" + "description": "the list of egress rules associated with the security group", + "name": "egressrule", + "response": [ + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "account owning the security group rule", + "name": "account", + "type": "string" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + } + ], + "type": "set" }, { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" }, { - "description": "the domain ID of the affinity group", - "name": "domainid", + "description": "the project id of the group", + "name": "projectid", "type": "string" }, { - "description": "the domain name of the affinity group", - "name": "domain", + "description": "the project name of the group", + "name": "project", "type": "string" }, { - "description": "the type of the affinity group", - "name": "type", + "description": "the domain ID of the security group", + "name": "domainid", "type": "string" - } - ], - "type": "set" - }, - { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", - "type": "string" - }, - { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", - "type": "string" - }, - { - "description": "list of security groups associated with the virtual machine", - "name": "securitygroup", - "response": [ - { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" }, { - "description": "the domain name of the security group", - "name": "domain", + "description": "the description of the security group", + "name": "description", "type": "string" }, { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" - }, - { - "description": "the domain ID of the security group", - "name": "domainid", + "description": "the ID of the security group", + "name": "id", "type": "string" }, { @@ -57990,14 +59100,19 @@ "type": "string" }, { - "description": "the id of the security group rule", - "name": "ruleid", + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", "type": "string" }, { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" }, { "description": "the ending IP of the security group rule ", @@ -58005,13 +59120,18 @@ "type": "integer" }, { - "description": "the code for the ICMP message response", - "name": "icmpcode", + "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": "account owning the security group rule", - "name": "account", + "description": "the id of the security group rule", + "name": "ruleid", "type": "string" }, { @@ -58019,38 +59139,38 @@ "name": "tags", "response": [ { - "description": "resource type", - "name": "resourcetype", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the 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 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 value", + "name": "value", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "tag key name", + "name": "key", "type": "string" }, { @@ -58059,254 +59179,404 @@ "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the 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 type of the ICMP message response", "name": "icmptype", "type": "integer" + } + ], + "type": "set" + }, + { + "description": "the name of the security group", + "name": "name", + "type": "string" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" }, { - "description": "the protocol of the security group rule", - "name": "protocol", + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "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": "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": "id of the resource", + "name": "resourceid", "type": "string" } ], "type": "set" + } + ], + "type": "set" + }, + { + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" + }, + { + "description": "OS type id of the vm", + "name": "ostypeid", + "type": "string" + }, + { + "description": "the ID of the virtual machine", + "name": "id", + "type": "string" + }, + { + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", + "type": "string" + }, + { + "description": "State of the Service from LB rule", + "name": "servicestate", + "type": "string" + }, + { + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" + }, + { + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", + "type": "string" + }, + { + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", + "type": "string" + }, + { + "description": "the 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", + "type": "string" + }, + { + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" + }, + { + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" + }, + { + "description": "the ID of the host for the virtual machine", + "name": "hostid", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" + }, + { + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", + "type": "string" + }, + { + "description": "the group name of the virtual machine", + "name": "group", + "type": "string" + }, + { + "description": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", + "response": [ + { + "description": "the 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 project ID of the affinity group", + "name": "projectid", + "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 project name of the affinity group", + "name": "project", + "type": "string" + }, + { + "description": "the description of the affinity group", + "name": "description", + "type": "string" + }, + { + "description": "the type of the affinity group", + "name": "type", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" + }, + { + "description": "the list of nics associated with vm", + "name": "nic", + "response": [ + { + "description": "the ip address of the nic", + "name": "ipaddress", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", + "type": "string" + }, + { + "description": "the gateway of the nic", + "name": "gateway", + "type": "string" + }, + { + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" }, { - "description": "the name of the security group", - "name": "name", + "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 account owning the security group", - "name": "account", + "description": "the name of the corresponding network", + "name": "networkname", "type": "string" }, { - "description": "the list of egress rules associated with the security group", - "name": "egressrule", - "response": [ - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the 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 value", - "name": "value", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, - { - "description": "account owning the security group rule", - "name": "account", - "type": "string" - } - ], - "type": "set" + "description": "the traffic type of the nic", + "name": "traffictype", + "type": "string" }, { - "description": "the project name of the group", - "name": "project", + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "the isolation uri of the nic", + "name": "isolationuri", "type": "string" }, { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the 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": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - } - ], - "type": "set" + "description": "the broadcast uri of the nic", + "name": "broadcasturi", + "type": "string" }, { - "description": "the description of the security group", - "name": "description", + "description": "the netmask of the nic", + "name": "netmask", "type": "string" }, { - "description": "the project id of the group", - "name": "projectid", + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "the type of the nic", + "name": "type", "type": "string" }, { - "description": "the ID of the security group", - "name": "id", + "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 extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "the ID of the corresponding network", + "name": "networkid", + "type": "string" + }, + { + "description": "the IPv6 address of network", + "name": "ip6address", + "type": "string" + }, + { + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "macaddress", + "type": "string" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "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": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" } ], "type": "set" }, { - "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": "Guest vm Boot Mode", - "name": "bootmode", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "description": "the internal memory that's free in vm or zero if it can not be calculated", - "name": "memoryintfreekbs", - "type": "long" + "description": "Guest vm Boot Type", + "name": "boottype", + "type": "string" }, { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", "type": "string" }, { @@ -58314,30 +59584,45 @@ "name": "instancename", "type": "string" }, + { + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" + }, + { + "description": "the project id of the vm", + "name": "projectid", + "type": "string" + }, + { + "description": "Os type ID of the virtual machine", + "name": "guestosid", + "type": "string" + }, { "description": "public IP address id associated with vm via Static nat rule", "name": "publicipid", "type": "string" }, { - "description": "the incoming network traffic on the vm", - "name": "networkkbsread", + "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": "public IP address id associated with vm via Static nat rule", + "name": "publicip", + "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" + "description": "the group ID of the virtual machine", + "name": "groupid", + "type": "string" }, { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { "description": "the pool type of the virtual machine", @@ -58345,23 +59630,85 @@ "type": "string" }, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", + "description": "the ID of the availablility zone for the virtual machine", + "name": "zoneid", "type": "string" }, { - "description": "the memory used by the vm", - "name": "memorykbs", - "type": "long" + "description": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "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": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the read (bytes) of disk on the vm", - "name": "diskkbsread", + "description": "the name of the virtual machine", + "name": "name", + "type": "string" + }, + { + "description": "the read (IO) of disk on the VM", + "name": "diskioread", "type": "long" }, { @@ -58370,34 +59717,28 @@ "type": "string" }, { - "description": "the password (if exists) of the virtual machine", - "name": "password", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "Guest vm Boot Type", - "name": "boottype", - "type": "string" + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", "type": "string" }, { - "description": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" - }, - {}, - { - "description": "the account associated with the virtual machine", - "name": "account", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { @@ -58406,88 +59747,110 @@ "type": "string" }, { - "description": "the outgoing network traffic on the host", - "name": "networkkbswrite", + "description": "device ID of the root volume", + "name": "rootdeviceid", "type": "long" }, { - "description": "State of the Service from LB rule", - "name": "servicestate", + "description": "ssh key-pairs", + "name": "keypairs", "type": "string" }, { - "description": "the memory allocated for the virtual machine", - "name": "memory", + "description": "the speed of each vCPU", + "name": "cpuspeed", "type": "integer" }, { - "description": "the name of the disk offering of the virtual machine", - "name": "diskofferingname", - "type": "string" + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "Guest vm Boot Mode", + "name": "bootmode", "type": "string" }, + {}, { - "description": "the group name of the virtual machine", - "name": "group", - "type": "string" + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" }, { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", "type": "string" }, { - "description": "the name of the host for the virtual machine", - "name": "hostname", + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" + }, + { + "description": "the memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" + }, + { + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" + }, + { + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", "type": "string" }, { - "description": "device type of the root volume", - "name": "rootdevicetype", + "description": "the project name of the vm", + "name": "project", "type": "string" }, { - "description": "the speed of each cpu", - "name": "cpuspeed", - "type": "integer" + "description": "the name of the template for the virtual machine", + "name": "templatename", + "type": "string" }, + {}, { - "description": "the ID of the virtual machine", - "name": "id", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, { - "description": "OS name of the vm", - "name": "osdisplayname", + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" + }, + { + "description": "device type of the root volume", + "name": "rootdevicetype", "type": "string" }, { - "description": "the number of cpu this virtual machine is running with", - "name": "cpunumber", - "type": "integer" + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", + "type": "boolean" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the 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": "OS name of the vm", + "name": "osdisplayname", "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 write (io) of disk on the vm", - "name": "diskiowrite", + "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", "type": "long" } ] @@ -58505,95 +59868,97 @@ "type": "boolean" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "account", + "name": "projectid", + "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "id of the customer gateway", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller 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": "createVpnCustomerGateway,listVpnCustomerGateways", + "name": "listall", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "list objects by project", + "description": "id of the customer gateway", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", + "name": "id", + "related": "createVpnCustomerGateway,listVpnCustomerGateways", "required": false, "type": "uuid" }, { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, { - "description": "list only resources belonging to the domain specified", + "description": "List by keyword", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "listall", + "name": "account", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "List by keyword", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "keyword", + "name": "domainid", + "related": "listDomainChildren,listDomains", "required": false, - "type": "string" + "type": "uuid" } ], "related": "createVpnCustomerGateway", "response": [ + {}, { - "description": "IPsec policy of customer gateway", - "name": "esppolicy", + "description": "IPsec preshared-key of customer gateway", + "name": "ipsecpsk", "type": "string" }, { - "description": "Lifetime of ESP SA of customer gateway", - "name": "esplifetime", - "type": "long" + "description": "if Force NAT Encapsulation is enabled for customer gateway", + "name": "forceencap", + "type": "boolean" }, { - "description": "the project name", - "name": "project", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the date and time the host was removed", - "name": "removed", - "type": "date" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "if DPD is enabled for customer gateway", - "name": "dpd", - "type": "boolean" + "description": "Lifetime of ESP SA of customer gateway", + "name": "esplifetime", + "type": "long" }, + {}, { - "description": "guest cidr list of the customer gateway. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", + "description": "the vpn gateway ID", + "name": "id", "type": "string" }, { @@ -58602,55 +59967,43 @@ "type": "string" }, { - "description": "Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Defaults to ike", - "name": "ikeversion", + "description": "name of the customer gateway", + "name": "name", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "guest cidr list of the customer gateway. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", "type": "string" }, - {}, - {}, { - "description": "IPsec preshared-key of customer gateway", - "name": "ipsecpsk", + "description": "the owner", + "name": "account", "type": "string" }, { - "description": "the project id", - "name": "projectid", + "description": "IPsec policy of customer gateway", + "name": "esppolicy", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "if DPD is enabled for customer gateway", + "name": "dpd", "type": "boolean" }, { - "description": "the domain name of the owner", - "name": "domain", + "description": "the project name", + "name": "project", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "if Force NAT Encapsulation is enabled for customer gateway", - "name": "forceencap", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "Lifetime of IKE SA of customer gateway", - "name": "ikelifetime", - "type": "long" - }, - { - "description": "the vpn gateway ID", - "name": "id", + "description": "Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Defaults to ike", + "name": "ikeversion", "type": "string" }, { @@ -58659,8 +60012,13 @@ "type": "string" }, { - "description": "the owner", - "name": "account", + "description": "IKE policy of customer gateway", + "name": "ikepolicy", + "type": "string" + }, + { + "description": "the domain name of the owner", + "name": "domain", "type": "string" }, { @@ -58669,13 +60027,18 @@ "type": "boolean" }, { - "description": "name of the customer gateway", - "name": "name", - "type": "string" + "description": "Lifetime of IKE SA of customer gateway", + "name": "ikelifetime", + "type": "long" }, { - "description": "IKE policy of customer gateway", - "name": "ikepolicy", + "description": "the date and time the host was removed", + "name": "removed", + "type": "date" + }, + { + "description": "the project id", + "name": "projectid", "type": "string" }, { @@ -58690,13 +60053,6 @@ "isasync": true, "name": "deleteManagementNetworkIpRange", "params": [ - { - "description": "The vlan id the ip range sits on", - "length": 255, - "name": "vlan", - "required": true, - "type": "string" - }, { "description": "The ending IP address.", "length": 255, @@ -58718,9 +60074,17 @@ "related": "updatePod,createManagementNetworkIpRange", "required": true, "type": "uuid" + }, + { + "description": "The vlan id the ip range sits on", + "length": 255, + "name": "vlan", + "required": true, + "type": "string" } ], "response": [ + {}, { "description": "true if operation is executed successfully", "name": "success", @@ -58736,13 +60100,12 @@ "name": "jobstatus", "type": "integer" }, + {}, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" - }, - {}, - {} + } ], "since": "4.11.0.0" }, @@ -58752,103 +60115,106 @@ "name": "addKubernetesSupportedVersion", "params": [ { - "description": "the name of the Kubernetes supported version", + "description": "the ID of the zone in which Kubernetes supported version will be available", "length": 255, - "name": "name", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "the semantic version of the Kubernetes version. It needs to be specified in MAJOR.MINOR.PATCH format", + "description": "the minimum number of CPUs to be set with the Kubernetes version", "length": 255, - "name": "semanticversion", + "name": "mincpunumber", "required": true, - "type": "string" + "type": "integer" }, { - "description": "the checksum value of the binaries ISO. The parameter containing the checksum will be considered a MD5sum if it is not prefixed\n and just a plain ascii/utf8 representation of a hexadecimal string. If it is required to\n use another algorithm the hexadecimal string is to be prefixed with a string of the form,\n \"{}\", not including the double quotes. In this is the exact string\n representing the java supported algorithm, i.e. MD5 or SHA-256. Note that java does not\n contain an algorithm called SHA256 or one called sha-256, only SHA-256.", + "description": "the name of the Kubernetes supported version", "length": 255, - "name": "checksum", + "name": "name", "required": false, "type": "string" }, { - "description": "the minimum number of CPUs to be set with the Kubernetes version", + "description": "the minimum RAM size in MB to be set with the Kubernetes version", "length": 255, - "name": "mincpunumber", + "name": "minmemory", "required": true, "type": "integer" }, { - "description": "the URL of the binaries ISO for Kubernetes supported version", + "description": "the semantic version of the Kubernetes version. It needs to be specified in MAJOR.MINOR.PATCH format", "length": 255, - "name": "url", - "required": false, + "name": "semanticversion", + "required": true, "type": "string" }, { - "description": "the ID of the zone in which Kubernetes supported version will be available", + "description": "the checksum value of the binaries ISO. The parameter containing the checksum will be considered a MD5sum if it is not prefixed\n and just a plain ascii/utf8 representation of a hexadecimal string. If it is required to\n use another algorithm the hexadecimal string is to be prefixed with a string of the form,\n \"{}\", not including the double quotes. In this is the exact string\n representing the java supported algorithm, i.e. MD5 or SHA-256. Note that java does not\n contain an algorithm called SHA256 or one called sha-256, only SHA-256.", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "checksum", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "the minimum RAM size in MB to be set with the Kubernetes version", + "description": "the URL of the binaries ISO for Kubernetes supported version", "length": 255, - "name": "minmemory", - "required": true, - "type": "integer" + "name": "url", + "required": false, + "type": "string" } ], "related": "listKubernetesSupportedVersions,updateKubernetesSupportedVersion", "response": [ { - "description": "the name of the zone in which Kubernetes supported version is available", - "name": "zonename", - "type": "string" + "description": "the date when this Kubernetes supported version was created", + "name": "created", + "type": "date" }, - {}, { - "description": "the id of the binaries ISO for Kubernetes supported version", - "name": "isoid", + "description": "the minimum number of CPUs needed for the Kubernetes supported version", + "name": "mincpunumber", + "type": "integer" + }, + { + "description": "the id of the Kubernetes supported version", + "name": "id", "type": "string" }, - {}, { "description": "whether Kubernetes supported version supports Autoscaling", "name": "supportsautoscaling", "type": "boolean" }, { - "description": "the id of the zone in which Kubernetes supported version is available", - "name": "zoneid", + "description": "Kubernetes semantic version", + "name": "semanticversion", "type": "string" }, { - "description": "whether Kubernetes supported version supports HA, multi-control nodes", - "name": "supportsha", - "type": "boolean" + "description": "the state of the binaries ISO for Kubernetes supported version", + "name": "isostate", + "type": "string" }, { - "description": "Name of the Kubernetes supported version", - "name": "name", + "description": "the id of the zone in which Kubernetes supported version is available", + "name": "zoneid", "type": "string" }, { - "description": "the minimum number of CPUs needed for the Kubernetes supported version", - "name": "mincpunumber", - "type": "integer" + "description": "the name of the zone in which Kubernetes supported version is available", + "name": "zonename", + "type": "string" }, { - "description": "the state of the binaries ISO for Kubernetes supported version", - "name": "isostate", + "description": "Name of the Kubernetes supported version", + "name": "name", "type": "string" }, { - "description": "the id of the Kubernetes supported version", - "name": "id", + "description": "the name of the binaries ISO for Kubernetes supported version", + "name": "isoname", "type": "string" }, { @@ -58857,28 +60223,30 @@ "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "the minimum RAM size in MB needed for the Kubernetes supported version", + "name": "minmemory", "type": "integer" }, { - "description": "Kubernetes semantic version", - "name": "semanticversion", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, { - "description": "the minimum RAM size in MB needed for the Kubernetes supported version", - "name": "minmemory", - "type": "integer" + "description": "whether Kubernetes supported version supports HA, multi-control nodes", + "name": "supportsha", + "type": "boolean" }, + {}, { - "description": "the name of the binaries ISO for Kubernetes supported version", - "name": "isoname", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the id of the binaries ISO for Kubernetes supported version", + "name": "isoid", "type": "string" } ] @@ -58898,12 +60266,17 @@ } ], "response": [ - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {}, { "description": "true if operation is executed successfully", "name": "success", @@ -58914,12 +60287,7 @@ "name": "displaytext", "type": "string" }, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - } + {} ] }, { @@ -58927,20 +60295,6 @@ "isasync": true, "name": "createGlobalLoadBalancerRule", "params": [ - { - "description": "name of the load balancer rule", - "length": 255, - "name": "name", - "required": true, - "type": "string" - }, - { - "description": "load balancer algorithm (roundrobin, leastconn, proximity) that method is used to distribute traffic across the zones participating in global server load balancing, if not specified defaults to 'round robin'", - "length": 255, - "name": "gslblbmethod", - "required": false, - "type": "string" - }, { "description": "the account associated with the global load balancer. Must be used with the domainId parameter.", "length": 255, @@ -58949,9 +60303,9 @@ "type": "string" }, { - "description": "session sticky method (sourceip) if not specified defaults to sourceip", + "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": "gslbstickysessionmethodname", + "name": "gslblbmethod", "required": false, "type": "string" }, @@ -58977,6 +60331,13 @@ "required": false, "type": "string" }, + { + "description": "name of the load balancer rule", + "length": 255, + "name": "name", + "required": true, + "type": "string" + }, { "description": "region where the global load balancer is going to be created.", "length": 255, @@ -58985,6 +60346,13 @@ "required": true, "type": "integer" }, + { + "description": "session sticky method (sourceip) if not specified defaults to sourceip", + "length": 255, + "name": "gslbstickysessionmethodname", + "required": false, + "type": "string" + }, { "description": "GSLB service type (tcp, udp, http)", "length": 255, @@ -58996,104 +60364,88 @@ "related": "listGlobalLoadBalancerRules,updateGlobalLoadBalancerRule", "response": [ { - "description": "the project name of the load balancer", - "name": "project", + "description": "global load balancer rule ID", + "name": "id", "type": "string" }, { - "description": "Load balancing method used for the global load balancer", - "name": "gslblbmethod", + "description": "DNS domain name given for the global load balancer", + "name": "gslbdomainname", "type": "string" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the description of the global load balancer rule", + "name": "description", + "type": "string" }, { - "description": "the domain of the load balancer rule", - "name": "domain", + "description": "the account of the load balancer rule", + "name": "account", "type": "string" }, { - "description": "name of the global load balancer rule", - "name": "name", + "description": "the project name of the load balancer", + "name": "project", "type": "string" }, { - "description": "global load balancer rule ID", - "name": "id", + "description": "session persistence method used for the global load balancer", + "name": "gslbstickysessionmethodname", "type": "string" }, { - "description": "the project id of the load balancer", - "name": "projectid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the domain ID of the load balancer rule", - "name": "domainid", + "description": "Load balancing method used for the global load balancer", + "name": "gslblbmethod", "type": "string" }, { - "description": "GSLB service type", - "name": "gslbservicetype", + "description": "the domain of the load balancer rule", + "name": "domain", "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the domain ID of the load balancer rule", + "name": "domainid", "type": "string" }, { - "description": "Region Id in which global load balancer is created", - "name": "regionid", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, - { - "description": "the account of the load balancer rule", - "name": "account", - "type": "string" - }, + {}, { "description": "List of load balancer rules that are part of GSLB rule", "name": "loadbalancerrule", "response": [ { - "description": "the state of the rule", - "name": "state", - "type": "string" - }, - { - "description": "the project name of the load balancer", - "name": "project", - "type": "string" - }, - { - "description": "the name of the zone the load balancer rule belongs to", - "name": "zonename", + "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 zone the rule belongs to", - "name": "zoneid", + "description": "the protocol of the loadbalanacer rule", + "name": "protocol", "type": "string" }, { - "description": "the load balancer algorithm (source, roundrobin, leastconn)", - "name": "algorithm", + "description": "the private port", + "name": "privateport", "type": "string" }, { - "description": "the domain of the load balancer rule", - "name": "domain", + "description": "the domain ID of the load balancer rule", + "name": "domainid", "type": "string" }, { - "description": "the project id of the load balancer", - "name": "projectid", + "description": "the id of the zone the rule belongs to", + "name": "zoneid", "type": "string" }, { @@ -59102,48 +60454,43 @@ "type": "boolean" }, { - "description": "the id of the guest network the lb rule belongs to", - "name": "networkid", - "type": "string" - }, - { - "description": "the name of the load balancer", - "name": "name", + "description": "the project name of the load balancer", + "name": "project", "type": "string" }, { - "description": "the private port", - "name": "privateport", + "description": "the project id of the load balancer", + "name": "projectid", "type": "string" }, { - "description": "the account of the load balancer rule", - "name": "account", + "description": "the name of the zone the load balancer rule belongs to", + "name": "zonename", "type": "string" }, { - "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", + "description": "the public ip address", + "name": "publicip", "type": "string" }, { - "description": "the public ip address", - "name": "publicip", + "description": "the id of the guest network the lb rule belongs to", + "name": "networkid", "type": "string" }, { - "description": "the domain ID of the load balancer rule", - "name": "domainid", + "description": "the name of the load balancer", + "name": "name", "type": "string" }, { - "description": "the protocol of the loadbalanacer rule", - "name": "protocol", + "description": "the load balancer rule ID", + "name": "id", "type": "string" }, { - "description": "the public ip address id", - "name": "publicipid", + "description": "the domain of the load balancer rule", + "name": "domain", "type": "string" }, { @@ -59152,8 +60499,8 @@ "type": "string" }, { - "description": "the description of the load balancer", - "name": "description", + "description": "the public ip address id", + "name": "publicipid", "type": "string" }, { @@ -59161,81 +60508,102 @@ "name": "tags", "response": [ { - "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" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "tag value", + "name": "value", "type": "string" } ], "type": "list" }, { - "description": "the load balancer rule ID", - "name": "id", + "description": "the load balancer algorithm (source, roundrobin, leastconn)", + "name": "algorithm", + "type": "string" + }, + { + "description": "the description of the load balancer", + "name": "description", + "type": "string" + }, + { + "description": "the state of the rule", + "name": "state", + "type": "string" + }, + { + "description": "the account of the load balancer rule", + "name": "account", "type": "string" } ], "type": "list" }, { - "description": "DNS domain name given for the global load balancer", - "name": "gslbdomainname", + "description": "name of the global load balancer rule", + "name": "name", + "type": "string" + }, + { + "description": "the project id of the load balancer", + "name": "projectid", "type": "string" }, { - "description": "the description of the global load balancer rule", - "name": "description", + "description": "GSLB service type", + "name": "gslbservicetype", "type": "string" }, { - "description": "session persistence method used for the global load balancer", - "name": "gslbstickysessionmethodname", - "type": "string" - } + "description": "Region Id in which global load balancer is created", + "name": "regionid", + "type": "integer" + }, + {} ] }, { @@ -59258,13 +60626,6 @@ "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", @@ -59274,6 +60635,13 @@ "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" } ] }, @@ -59291,27 +60659,12 @@ "type": "uuid" }, { - "description": "region ID", - "length": 255, - "name": "regionid", - "related": "addRegion,listRegions", - "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", + "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 by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - }, { "description": "", "length": 255, @@ -59320,11 +60673,11 @@ "type": "integer" }, { - "description": "", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "pagesize", + "name": "listall", "required": false, - "type": "integer" + "type": "boolean" }, { "description": "list resources by account. Must be used with the domainId parameter.", @@ -59334,14 +60687,14 @@ "type": "string" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "List by keyword", "length": 255, - "name": "isrecursive", + "name": "keyword", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "list objects by project", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, "name": "projectid", "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", @@ -59349,11 +60702,11 @@ "type": "uuid" }, { - "description": "List resources by tags (key/value pairs)", + "description": "", "length": 255, - "name": "tags", + "name": "pagesize", "required": false, - "type": "map" + "type": "integer" }, { "description": "the ID of the global load balancer rule", @@ -59362,19 +60715,33 @@ "related": "listGlobalLoadBalancerRules,updateGlobalLoadBalancerRule", "required": false, "type": "uuid" + }, + { + "description": "List resources by tags (key/value pairs)", + "length": 255, + "name": "tags", + "required": false, + "type": "map" + }, + { + "description": "region ID", + "length": 255, + "name": "regionid", + "related": "addRegion,listRegions", + "required": false, + "type": "integer" } ], "related": "updateGlobalLoadBalancerRule", "response": [ { - "description": "the description of the global load balancer rule", - "name": "description", + "description": "the domain ID of the load balancer rule", + "name": "domainid", "type": "string" }, - {}, { - "description": "the project name of the load balancer", - "name": "project", + "description": "name of the global load balancer rule", + "name": "name", "type": "string" }, { @@ -59383,27 +60750,32 @@ "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Load balancing method used for the global load balancer", + "name": "gslblbmethod", "type": "string" }, { - "description": "Load balancing method used for the global load balancer", - "name": "gslblbmethod", + "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 description of the global load balancer rule", + "name": "description", + "type": "string" + }, + { + "description": "the project name of the load balancer", + "name": "project", + "type": "string" }, { "description": "List of load balancer rules that are part of GSLB rule", "name": "loadbalancerrule", "response": [ { - "description": "the id of the guest network the lb rule belongs to", - "name": "networkid", + "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", "type": "string" }, { @@ -59411,25 +60783,10 @@ "name": "project", "type": "string" }, - { - "description": "the id of the zone the rule belongs to", - "name": "zoneid", - "type": "string" - }, - { - "description": "the private port", - "name": "privateport", - "type": "string" - }, { "description": "the list of resource tags associated with load balancer", "name": "tags", "response": [ - { - "description": "tag value", - "name": "value", - "type": "string" - }, { "description": "resource type", "name": "resourcetype", @@ -59440,19 +60797,14 @@ "name": "project", "type": "string" }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, { "description": "tag key name", "name": "key", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { @@ -59474,73 +60826,88 @@ "description": "the account associated with the tag", "name": "account", "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" } ], "type": "list" }, { - "description": "the public ip address id", - "name": "publicipid", + "description": "the public ip address", + "name": "publicip", "type": "string" }, { - "description": "the public ip address", - "name": "publicip", + "description": "is rule for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, + { + "description": "the domain of the load balancer rule", + "name": "domain", "type": "string" }, { - "description": "the load balancer algorithm (source, roundrobin, leastconn)", - "name": "algorithm", + "description": "the protocol of the loadbalanacer rule", + "name": "protocol", "type": "string" }, { - "description": "the name of the load balancer", - "name": "name", + "description": "the description of the load balancer", + "name": "description", "type": "string" }, { - "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", + "description": "the private port", + "name": "privateport", "type": "string" }, { - "description": "the domain of the load balancer rule", - "name": "domain", + "description": "the name of the zone the load balancer rule belongs to", + "name": "zonename", "type": "string" }, { - "description": "the load balancer rule ID", - "name": "id", + "description": "the account of the load balancer rule", + "name": "account", "type": "string" }, { - "description": "the public port", - "name": "publicport", + "description": "the id of the zone the rule belongs to", + "name": "zoneid", "type": "string" }, { - "description": "the protocol of the loadbalanacer rule", - "name": "protocol", + "description": "the name of the load balancer", + "name": "name", "type": "string" }, { - "description": "the state of the rule", - "name": "state", + "description": "the public ip address id", + "name": "publicipid", "type": "string" }, { - "description": "the description of the load balancer", - "name": "description", + "description": "the id of the guest network the lb rule belongs to", + "name": "networkid", "type": "string" }, { - "description": "is rule for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "the state of the rule", + "name": "state", + "type": "string" }, { - "description": "the account of the load balancer rule", - "name": "account", + "description": "the domain ID of the load balancer rule", + "name": "domainid", "type": "string" }, { @@ -59549,13 +60916,18 @@ "type": "string" }, { - "description": "the name of the zone the load balancer rule belongs to", - "name": "zonename", + "description": "the load balancer rule ID", + "name": "id", "type": "string" }, { - "description": "the domain ID of the load balancer rule", - "name": "domainid", + "description": "the public port", + "name": "publicport", + "type": "string" + }, + { + "description": "the load balancer algorithm (source, roundrobin, leastconn)", + "name": "algorithm", "type": "string" } ], @@ -59566,84 +60938,41 @@ "name": "projectid", "type": "string" }, + {}, { - "description": "the domain ID of the load balancer rule", - "name": "domainid", - "type": "string" - }, - { - "description": "Region Id in which global load balancer is created", - "name": "regionid", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, - { - "description": "global load balancer rule ID", - "name": "id", - "type": "string" - }, { "description": "the domain of the load balancer rule", "name": "domain", "type": "string" }, - { - "description": "session persistence method used for the global load balancer", - "name": "gslbstickysessionmethodname", - "type": "string" - }, - { - "description": "DNS domain name given for the global load balancer", - "name": "gslbdomainname", - "type": "string" - }, {}, { "description": "GSLB service type", "name": "gslbservicetype", "type": "string" }, - { - "description": "name of the global load balancer rule", - "name": "name", - "type": "string" - } - ] - }, - { - "description": "Release the dedication for cluster", - "isasync": true, - "name": "releaseDedicatedCluster", - "params": [ - { - "description": "the ID of the Cluster", - "length": 255, - "name": "clusterid", - "related": "addCluster,updateCluster", - "required": true, - "type": "uuid" - } - ], - "response": [ - {}, { "description": "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": "Region Id in which global load balancer is created", + "name": "regionid", + "type": "integer" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "session persistence method used for the global load balancer", + "name": "gslbstickysessionmethodname", + "type": "string" }, - {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "DNS domain name given for the global load balancer", + "name": "gslbdomainname", "type": "string" } ] @@ -59663,17 +60992,17 @@ } ], "response": [ - {}, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, + {}, + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", @@ -59681,9 +61010,9 @@ }, {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" } ] }, @@ -59693,18 +61022,19 @@ "name": "listTags", "params": [ { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "account", + "name": "projectid", + "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "list by resource id", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "resourceid", + "name": "isrecursive", "required": false, - "type": "string" + "type": "boolean" }, { "description": "list by resource type", @@ -59714,74 +61044,73 @@ "type": "string" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "", "length": 255, - "name": "isrecursive", + "name": "pagesize", "required": false, - "type": "boolean" + "type": "integer" }, { - "description": "list only resources belonging to the domain specified", + "description": "list by resource id", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", + "name": "resourceid", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "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": "", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "pagesize", + "name": "account", "required": false, - "type": "integer" + "type": "string" }, { - "description": "list objects by project", + "description": "list by value", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", + "name": "value", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "list by key", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "key", + "name": "domainid", + "related": "listDomainChildren,listDomains", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "page", + "name": "listall", "required": false, - "type": "integer" + "type": "boolean" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false", + "description": "list by key", "length": 255, - "name": "listall", + "name": "key", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "list by value", + "description": "list by customer name", "length": 255, - "name": "value", + "name": "customer", "required": false, "type": "string" } @@ -59789,22 +61118,37 @@ "related": "", "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", "type": "string" }, - {}, - {}, { "description": "tag value", "name": "value", "type": "string" }, + {}, + {}, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", "type": "string" }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "tag key name", "name": "key", @@ -59816,42 +61160,66 @@ "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "id of the resource", + "name": "resourceid", "type": "string" - }, + } + ], + "since": "4.0.0" + }, + { + "description": "Release the dedication for cluster", + "isasync": true, + "name": "releaseDedicatedCluster", + "params": [ { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the ID of the Cluster", + "length": 255, + "name": "clusterid", + "related": "addCluster,updateCluster", + "required": true, + "type": "uuid" + } + ], + "response": [ + { + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, + {}, { - "description": "the account associated with the tag", - "name": "account", - "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.0.0" + ] }, { "description": "Get Kubernetes cluster config", @@ -59869,31 +61237,31 @@ ], "related": "", "response": [ - {}, { "description": "Name of the container cluster", "name": "name", "type": "string" }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + {}, { - "description": "the config data of the cluster", - "name": "configdata", + "description": "the id of the container cluster", + "name": "id", "type": "string" }, {}, { - "description": "the id of the container cluster", - "name": "id", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the config data of the cluster", + "name": "configdata", "type": "string" } ] @@ -59922,35 +61290,31 @@ ], "related": "configureVirtualRouterElement,listVirtualRouterElements", "response": [ - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, {}, { - "description": "the domain associated with the provider", - "name": "domain", + "description": "the project id of the ipaddress", + "name": "projectid", "type": "string" }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "the physical network service provider id of the provider", "name": "nspid", "type": "string" }, { - "description": "Enabled/Disabled the service provider", - "name": "enabled", - "type": "boolean" + "description": "the project name of the address", + "name": "project", + "type": "string" }, + {}, { - "description": "the account associated with the provider", - "name": "account", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the domain associated with the provider", + "name": "domain", "type": "string" }, { @@ -59964,15 +61328,19 @@ "type": "string" }, { - "description": "the project name of the address", - "name": "project", - "type": "string" + "description": "the account associated with the provider", + "name": "account", + "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 current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ] }, @@ -59990,42 +61358,50 @@ "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": "create VPC for the project", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", + "name": "projectid", + "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", "required": false, "type": "uuid" }, { - "description": "the ID of the availability zone", + "description": "the cidr of the VPC. All VPC guest networks' cidrs should be within this CIDR", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "cidr", "required": true, + "type": "string" + }, + { + "description": "the domain ID associated with the VPC. If used with the account parameter returns the VPC associated with the account for the specified domain.", + "length": 255, + "name": "domainid", + "related": "listDomainChildren,listDomains", + "required": false, "type": "uuid" }, { - "description": "the name of the VPC", + "description": "the display text of the VPC", "length": 255, - "name": "name", + "name": "displaytext", "required": true, "type": "string" }, { - "description": "If set to false, the VPC won't start (VPC VR will not get allocated) until its first network gets implemented. True by default.", + "description": "the ID of the VPC offering", "length": 255, - "name": "start", - "required": false, - "since": "4.3", - "type": "boolean" + "name": "vpcofferingid", + "related": "updateVPCOffering", + "required": true, + "type": "uuid" }, { - "description": "the account associated with the VPC. Must be used with the domainId parameter.", + "description": "the ID of the availability zone", "length": 255, - "name": "account", - "required": false, - "type": "string" + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": true, + "type": "uuid" }, { "description": "VPC network domain. All networks inside the VPC will belong to this domain", @@ -60035,32 +61411,24 @@ "type": "string" }, { - "description": "create VPC for the project", + "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": "projectid", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", + "name": "start", "required": false, - "type": "uuid" - }, - { - "description": "the ID of the VPC offering", - "length": 255, - "name": "vpcofferingid", - "related": "updateVPCOffering", - "required": true, - "type": "uuid" + "since": "4.3", + "type": "boolean" }, { - "description": "the cidr of the VPC. All VPC guest networks' cidrs should be within this CIDR", + "description": "the account associated with the VPC. Must be used with the domainId parameter.", "length": 255, - "name": "cidr", - "required": true, + "name": "account", + "required": false, "type": "string" }, { - "description": "the display text of the VPC", + "description": "the name of the VPC", "length": 255, - "name": "displaytext", + "name": "name", "required": true, "type": "string" } @@ -60068,131 +61436,76 @@ "related": "listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", "response": [ { - "description": "the list of resource tags associated with the project", - "name": "tags", - "response": [ - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "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 current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "true VPC requires restart", - "name": "restartrequired", - "type": "boolean" - }, - { - "description": "vpc offering name the VPC is created from", - "name": "vpcofferingname", + "description": "the project id of the VPC", + "name": "projectid", "type": "string" }, { - "description": "an alternate display text of the VPC.", - "name": "displaytext", + "description": "the project name of the VPC", + "name": "project", "type": "string" }, - {}, { - "description": "the domain id of the VPC owner", - "name": "domainid", + "description": "zone id of the vpc", + "name": "zoneid", "type": "string" }, { - "description": "state of the VPC. Can be Inactive/Enabled", - "name": "state", + "description": "the owner of the VPC", + "name": "account", "type": "string" }, - { - "description": "is vpc 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": "vpc offering id the VPC is created from", - "name": "vpcofferingid", + "description": "the cidr the VPC", + "name": "cidr", "type": "string" }, { - "description": "the project name of the VPC", - "name": "project", - "type": "string" + "description": "the date this VPC was created", + "name": "created", + "type": "date" }, { - "description": "the network domain of the VPC", - "name": "networkdomain", - "type": "string" + "description": "is vpc for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, { - "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 list of supported services", "name": "service", "response": [ { - "description": "the service name", - "name": "name", - "type": "string" + "description": "the list of capabilities", + "name": "capability", + "response": [ + { + "description": "the capability value", + "name": "value", + "type": "string" + }, + { + "description": "can this service capability value can be choosable while creatine network offerings", + "name": "canchooseservicecapability", + "type": "boolean" + }, + { + "description": "the capability name", + "name": "name", + "type": "string" + } + ], + "type": "list" }, { "description": "the service provider name", @@ -60208,21 +61521,11 @@ "name": "destinationphysicalnetworkid", "type": "string" }, - { - "description": "services for this provider", - "name": "servicelist", - "type": "list" - }, { "description": "true if individual services can be enabled/disabled", "name": "canenableindividualservice", "type": "boolean" }, - { - "description": "uuid of the network provider", - "name": "id", - "type": "string" - }, { "description": "the physical network this belongs to", "name": "physicalnetworkid", @@ -60232,40 +61535,89 @@ "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": "can this service capability value can be choosable while creatine network offerings", - "name": "canchooseservicecapability", - "type": "boolean" + "description": "uuid of the network provider", + "name": "id", + "type": "string" }, { - "description": "the capability name", - "name": "name", - "type": "string" + "description": "services for this provider", + "name": "servicelist", + "type": "list" } ], "type": "list" + }, + { + "description": "the service name", + "name": "name", + "type": "string" } ], "type": "list" }, - {}, { - "description": "is VPC uses distributed router for one hop forwarding and host based network ACL's", - "name": "distributedvpcrouter", - "type": "boolean" + "description": "the list of resource tags associated with the project", + "name": "tags", + "response": [ + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + } + ], + "type": "list" + }, + { + "description": "state of the VPC. Can be Inactive/Enabled", + "name": "state", + "type": "string" }, { "description": "Base64 string representation of the resource icon", @@ -60273,14 +61625,19 @@ "type": "resourceiconresponse" }, { - "description": "the domain name of the owner", - "name": "domain", + "description": "the name of the VPC", + "name": "name", "type": "string" }, { - "description": "the list of networks belongign to the VPC", - "name": "network", - "type": "list" + "description": "true VPC requires restart", + "name": "restartrequired", + "type": "boolean" + }, + { + "description": "is VPC uses distributed router for one hop forwarding and host based network ACL's", + "name": "distributedvpcrouter", + "type": "boolean" }, { "description": "true if VPC is region level", @@ -60288,49 +61645,65 @@ "type": "boolean" }, { - "description": "the name of the VPC", - "name": "name", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "zone id of the vpc", - "name": "zoneid", + "description": "vpc offering id the VPC is created from", + "name": "vpcofferingid", "type": "string" }, { - "description": "the project id of the VPC", - "name": "projectid", + "description": "the name of the zone the VPC belongs to", + "name": "zonename", "type": "string" }, { - "description": "if this VPC has redundant router", - "name": "redundantvpcrouter", - "type": "boolean" + "description": "the list of networks belongign to the VPC", + "name": "network", + "type": "list" }, { - "description": "the owner of the VPC", - "name": "account", + "description": "vpc offering name the VPC is created from", + "name": "vpcofferingname", "type": "string" }, { - "description": "the cidr the VPC", - "name": "cidr", + "description": "the domain id of the VPC owner", + "name": "domainid", "type": "string" }, { - "description": "the name of the zone the VPC belongs to", - "name": "zonename", + "description": "the id of the VPC", + "name": "id", "type": "string" }, + {}, { - "description": "the id of the VPC", - "name": "id", + "description": "the network domain of the VPC", + "name": "networkdomain", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "an alternate display text of the VPC.", + "name": "displaytext", + "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 domain name of the owner", + "name": "domain", + "type": "string" } ] }, @@ -60349,26 +61722,26 @@ } ], "response": [ - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - }, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" } ] @@ -60388,18 +61761,6 @@ } ], "response": [ - {}, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - }, { "description": "true if operation is executed successfully", "name": "success", @@ -60409,6 +61770,18 @@ "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" + }, + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + }, + {}, + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ], "since": "4.9.0" @@ -60428,7 +61801,6 @@ } ], "response": [ - {}, { "description": "true if operation is executed successfully", "name": "success", @@ -60439,17 +61811,18 @@ "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" - }, - {} + } ] }, { @@ -60458,85 +61831,86 @@ "name": "listInternalLoadBalancerVMs", "params": [ { - "description": "", + "description": "if true is passed for this parameter, also fetch last executed health check results for the VM. Default is false", "length": 255, - "name": "page", + "name": "fetchhealthcheckresults", "required": false, - "type": "integer" + "since": "4.14", + "type": "boolean" }, { - "description": "the host ID of the Internal LB VM", + "description": "the state of the Internal LB VM", "length": 255, - "name": "hostid", - "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost,addBaremetalHost", + "name": "state", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "list by network id", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "networkid", - "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listF5LoadBalancerNetworks,listNetscalerLoadBalancerNetworks,listSrxFirewallNetworks,listBrocadeVcsDeviceNetworks", + "name": "domainid", + "related": "listDomainChildren,listDomains", "required": false, "type": "uuid" }, { - "description": "list objects by project", + "description": "the Pod ID of the Internal LB VM", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", + "name": "podid", + "related": "updatePod,createManagementNetworkIpRange", "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", + "description": "", "length": 255, - "name": "fetchhealthcheckresults", + "name": "pagesize", "required": false, - "since": "4.14", - "type": "boolean" + "type": "integer" }, { - "description": "List Internal LB VMs by VPC", + "description": "the ID of the Internal LB VM", "length": 255, - "name": "vpcid", - "related": "listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", + "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": "If set to false, list only 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 host ID of the Internal LB VM", "length": 255, - "name": "listall", + "name": "hostid", + "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost", "required": false, - "type": "boolean" + "type": "uuid" }, { - "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": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "isrecursive", + "name": "listall", "required": false, "type": "boolean" }, { - "description": "the name of the Internal LB VM", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "name", + "name": "isrecursive", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "list only resources belonging to the domain specified", + "description": "list by network id", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", + "name": "networkid", + "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listSrxFirewallNetworks,listBrocadeVcsDeviceNetworks", "required": false, "type": "uuid" }, @@ -60549,24 +61923,23 @@ "type": "uuid" }, { - "description": "List by keyword", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "keyword", + "name": "account", "required": false, "type": "string" }, { - "description": "the Pod ID of the Internal LB VM", + "description": "", "length": 255, - "name": "podid", - "related": "updatePod,createManagementNetworkIpRange", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "the state of the Internal LB VM", + "description": "List by keyword", "length": 255, - "name": "state", + "name": "keyword", "required": false, "type": "string" }, @@ -60578,17 +61951,17 @@ "type": "boolean" }, { - "description": "the ID of the Internal LB VM", + "description": "List Internal LB VMs by VPC", "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", + "name": "vpcid", + "related": "listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", "required": false, "type": "uuid" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "the name of the Internal LB VM", "length": 255, - "name": "account", + "name": "name", "required": false, "type": "string" } @@ -60596,201 +61969,63 @@ "related": "destroyRouter,listRouters", "response": [ { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the public MAC address for the router", + "name": "publicmacaddress", "type": "string" }, { - "description": "the link local netmask for the router", - "name": "linklocalnetmask", + "description": "the ID of the corresponding public network", + "name": "publicnetworkid", "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": "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": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "true if nic is default, false otherwise", - "name": "macaddress", - "type": "string" - }, - { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - }, - { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" - }, - { - "description": "the name of the corresponding network", - "name": "networkname", - "type": "string" - }, - { - "description": "the 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 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 isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", - "type": "string" - }, - { - "description": "Type of adapter if available", - "name": "adaptertype", - "type": "string" - }, - { - "description": "the traffic type of the nic", - "name": "traffictype", - "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 ID of the corresponding network", - "name": "networkid", - "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 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": "the IPv6 address of network", - "name": "ip6address", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the name of the corresponding guest network", - "name": "guestnetworkname", + "description": "the name of VPC the router belongs to", + "name": "vpcname", "type": "string" }, { - "description": "the Zone name for the router", - "name": "zonename", + "description": "the gateway for the router", + "name": "gateway", "type": "string" }, { - "description": "the domain associated with the router", - "name": "domain", + "description": "the project id of the ipaddress", + "name": "projectid", "type": "string" }, { - "description": "the host ID for the router", - "name": "hostid", + "description": "the link local MAC address for the router", + "name": "linklocalmacaddress", "type": "string" }, { - "description": "the ID of the corresponding link local network", - "name": "linklocalnetworkid", + "description": "the project name of the address", + "name": "project", "type": "string" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "the host ID for the router", + "name": "hostid", "type": "string" }, - {}, { - "description": "the link local IP address for the router", - "name": "linklocalip", + "description": "the second IPv6 DNS for the router", + "name": "ip6dns2", "type": "string" }, { - "description": "the name of VPC the router belongs to", - "name": "vpcname", - "type": "string" + "description": "the date and time the router was created", + "name": "created", + "type": "date" }, { - "description": "role of the domain router", - "name": "role", + "description": "VPC the router belongs to", + "name": "vpcid", "type": "string" }, { - "description": "the Zone ID for the router", - "name": "zoneid", + "description": "the account associated with the router", + "name": "account", "type": "string" }, { @@ -60799,86 +62034,63 @@ "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": "Last executed health check result for the router", - "name": "healthcheckresults", - "response": [ - { - "description": "result of the health check", - "name": "success", - "type": "boolean" - }, - { - "description": "the type of the health check - basic or advanced", - "name": "checktype", - "type": "string" - }, - { - "description": "detailed response generated on running health check", - "name": "details", - "type": "string" - }, - { - "description": "the name of the health check on the router", - "name": "checkname", - "type": "string" - }, - { - "description": "the date this VPC was created", - "name": "lastupdated", - "type": "date" - } - ], - "type": "list" + "description": "the ID of the corresponding link local network", + "name": "linklocalnetworkid", + "type": "string" }, { - "description": "the guest MAC address for the router", - "name": "guestmacaddress", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, { - "description": "the template ID for the router", - "name": "templateid", + "description": "the first IPv6 DNS for the router", + "name": "ip6dns1", "type": "string" }, { - "description": "the network domain for the router", - "name": "networkdomain", + "description": "the version of scripts", + "name": "scriptsversion", "type": "string" }, { - "description": "the Pod ID for the router", - "name": "podid", + "description": "the Zone name for the router", + "name": "zonename", "type": "string" }, { - "description": "the id of the router", - "name": "id", + "description": "the name of the router", + "name": "name", "type": "string" }, { - "description": "the version of scripts", - "name": "scriptsversion", + "description": "the guest MAC address for the router", + "name": "guestmacaddress", "type": "string" }, - {}, { - "description": "if this router is an redundant virtual router", - "name": "isredundantrouter", - "type": "boolean" + "description": "the state of redundant virtual router", + "name": "redundantstate", + "type": "string" }, { - "description": "the hostname for the router", - "name": "hostname", + "description": "the guest netmask for the router", + "name": "guestnetmask", "type": "string" }, { - "description": "the Pod name for the router", - "name": "podname", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" + }, + { + "description": "the link local netmask for the router", + "name": "linklocalnetmask", "type": "string" }, { @@ -60887,129 +62099,305 @@ "type": "state" }, { - "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 link local MAC address for the router", - "name": "linklocalmacaddress", + "description": "the id of the router", + "name": "id", "type": "string" }, { - "description": "the guest IP address for the router", - "name": "guestipaddress", + "description": "the domain ID associated with the router", + "name": "domainid", "type": "string" }, { - "description": "VPC the router belongs to", - "name": "vpcid", + "description": "the template ID for the router", + "name": "templateid", "type": "string" }, { - "description": "the first IPv6 DNS for the router", - "name": "ip6dns1", + "description": "the ID of the corresponding guest network", + "name": "guestnetworkid", "type": "string" }, { - "description": "the version of template", - "name": "version", + "description": "the Zone ID for the router", + "name": "zoneid", "type": "string" }, { - "description": "the public MAC address for the router", - "name": "publicmacaddress", - "type": "string" + "description": "true if any health checks had failed", + "name": "healthchecksfailed", + "type": "boolean" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "the version of the code / software in the router", + "name": "softwareversion", "type": "string" }, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the guest IP address for the router", + "name": "guestipaddress", "type": "string" }, { - "description": "the ID of the corresponding guest network", - "name": "guestnetworkid", + "description": "the template name for the router", + "name": "templatename", "type": "string" }, { - "description": "the state of redundant virtual router", - "name": "redundantstate", + "description": "the public netmask for the router", + "name": "publicnetmask", "type": "string" }, { - "description": "the public netmask for the router", - "name": "publicnetmask", + "description": "the name of the corresponding guest network", + "name": "guestnetworkname", "type": "string" }, { - "description": "the domain ID associated with the router", - "name": "domainid", + "description": "the network domain for the router", + "name": "networkdomain", "type": "string" }, { - "description": "the guest netmask for the router", - "name": "guestnetmask", + "description": "Last executed health check result for the router", + "name": "healthcheckresults", + "response": [ + { + "description": "detailed response generated on running health check", + "name": "details", + "type": "string" + }, + { + "description": "the type of the health check - basic or advanced", + "name": "checktype", + "type": "string" + }, + { + "description": "result of the health check", + "name": "success", + "type": "boolean" + }, + { + "description": "the name of the health check on the router", + "name": "checkname", + "type": "string" + }, + { + "description": "the date this VPC was created", + "name": "lastupdated", + "type": "date" + } + ], + "type": "list" + }, + {}, + { + "description": "the hostname for the router", + "name": "hostname", "type": "string" }, { - "description": "true if the router template requires upgrader", - "name": "requiresupgrade", - "type": "boolean" + "description": "the domain associated with the router", + "name": "domain", + "type": "string" }, { - "description": "the account associated with the router", - "name": "account", + "description": "the Pod ID for the router", + "name": "podid", "type": "string" }, { - "description": "the ID of the corresponding public network", - "name": "publicnetworkid", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, { - "description": "the date and time the router was created", - "name": "created", - "type": "date" + "description": "the link local IP address for the router", + "name": "linklocalip", + "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the version of template", + "name": "version", + "type": "string" }, { - "description": "true if any health checks had failed", - "name": "healthchecksfailed", - "type": "boolean" + "description": "the list of nics associated with the router", + "name": "nic", + "response": [ + { + "description": "the broadcast uri of the nic", + "name": "broadcasturi", + "type": "string" + }, + { + "description": "the ip address of the nic", + "name": "ipaddress", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "macaddress", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", + "type": "string" + }, + { + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" + }, + { + "description": "the ID of the nic", + "name": "id", + "type": "string" + }, + { + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", + "type": "string" + }, + { + "description": "the name of the corresponding network", + "name": "networkname", + "type": "string" + }, + { + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", + "type": "string" + }, + { + "description": "the traffic type of the nic", + "name": "traffictype", + "type": "string" + }, + { + "description": "the type of the nic", + "name": "type", + "type": "string" + }, + { + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", + "type": "string" + }, + { + "description": "the isolation uri of the nic", + "name": "isolationuri", + "type": "string" + }, + { + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", + "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 ID of the corresponding network", + "name": "networkid", + "type": "string" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + }, + { + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "the gateway of the nic", + "name": "gateway", + "type": "string" + }, + { + "description": "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 netmask of the nic", + "name": "netmask", + "type": "string" + }, + { + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", + "type": "string" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" + }, + { + "description": "the IPv6 address of network", + "name": "ip6address", + "type": "string" + } + ], + "type": "set" }, { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "role of the domain router", + "name": "role", "type": "string" }, { - "description": "the template name for the router", - "name": "templatename", + "description": "the Pod name for the router", + "name": "podname", "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 gateway for the router", - "name": "gateway", + "description": "the public IP address for the router", + "name": "publicip", "type": "string" }, { - "description": "the name of the router", - "name": "name", - "type": "string" + "description": "true if the router template requires upgrader", + "name": "requiresupgrade", + "type": "boolean" }, { "description": "the first DNS for the router", @@ -61017,9 +62405,9 @@ "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" } ] }, @@ -61031,24 +62419,24 @@ { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, { - "description": "", + "description": "Cisco VNMC resource ID", "length": 255, - "name": "page", + "name": "resourceid", + "related": "listCiscoVnmcResources", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "the Physical Network ID", + "description": "", "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" }, { "description": "List by keyword", @@ -61058,32 +62446,32 @@ "type": "string" }, { - "description": "Cisco VNMC resource ID", + "description": "the Physical Network ID", "length": 255, - "name": "resourceid", - "related": "listCiscoVnmcResources", + "name": "physicalnetworkid", + "related": "createPhysicalNetwork", "required": false, "type": "uuid" } ], "related": "", "response": [ + {}, + {}, + {}, + {}, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, {}, - {}, - {}, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - {}, - {}, {} ] }, @@ -61116,9 +62504,9 @@ ], "response": [ { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, { "description": "the current status of the latest async job acting on this object", @@ -61127,9 +62515,9 @@ }, {}, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" }, {}, { @@ -61144,6 +62532,13 @@ "isasync": false, "name": "listOsTypes", "params": [ + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, { "description": "", "length": 255, @@ -61152,11 +62547,10 @@ "type": "integer" }, { - "description": "list os by description", + "description": "List by keyword", "length": 255, - "name": "description", + "name": "keyword", "required": false, - "since": "3.0.1", "type": "string" }, { @@ -61167,13 +62561,6 @@ "required": false, "type": "uuid" }, - { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, { "description": "list by Os type Id", "length": 255, @@ -61183,46 +62570,47 @@ "type": "uuid" }, { - "description": "List by keyword", + "description": "list os by description", "length": 255, - "name": "keyword", + "name": "description", "required": false, + "since": "3.0.1", "type": "string" } ], "related": "addGuestOs", "response": [ + {}, { - "description": "the name/description of the OS type", - "name": "description", - "type": "string" + "description": "is the guest OS user defined", + "name": "isuserdefined", + "type": "boolean" }, - {}, { "description": "the ID of the OS type", "name": "id", "type": "string" }, - {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, + {}, { "description": "the ID of the OS category", "name": "oscategoryid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "is the guest OS user defined", - "name": "isuserdefined", - "type": "boolean" + "description": "the name/description of the OS type", + "name": "description", + "type": "string" } ] }, @@ -61241,28 +62629,28 @@ } ], "response": [ - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" }, + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, {}, - {} + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + } ], "since": "3.0.0" }, @@ -61288,21 +62676,21 @@ "type": "boolean" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - } + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + }, + {} ], "since": "4.4.0" }, @@ -61311,6 +62699,13 @@ "isasync": false, "name": "uploadResourceIcon", "params": [ + { + "description": "type of the resource", + "length": 255, + "name": "resourcetype", + "required": true, + "type": "string" + }, { "description": "list of resources to upload the icon/image for", "length": 255, @@ -61324,13 +62719,6 @@ "name": "base64image", "required": true, "type": "string" - }, - { - "description": "type of the resource", - "length": 255, - "name": "resourcetype", - "required": true, - "type": "string" } ], "response": [ @@ -61345,16 +62733,16 @@ "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" } ], "since": "4.16.0.0" @@ -61364,6 +62752,14 @@ "isasync": false, "name": "listSrxFirewallNetworks", "params": [ + { + "description": "netscaler load balancer device ID", + "length": 255, + "name": "lbdeviceid", + "related": "configureSrxFirewall", + "required": true, + "type": "uuid" + }, { "description": "", "length": 255, @@ -61372,273 +62768,840 @@ "type": "integer" }, { - "description": "netscaler load balancer device ID", - "length": 255, - "name": "lbdeviceid", - "related": "configureSrxFirewall", - "required": true, - "type": "uuid" + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + } + ], + "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listBrocadeVcsDeviceNetworks", + "response": [ + { + "description": "the name of the Network associated with this network", + "name": "associatednetwork", + "type": "string" + }, + { + "description": "the domain name of the network owner", + "name": "domain", + "type": "string" + }, + { + "description": "the date this network was created", + "name": "created", + "type": "date" + }, + { + "description": "acl type - access type to the network", + "name": "acltype", + "type": "string" + }, + { + "description": "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": "the name of the zone the network belongs to", + "name": "zonename", + "type": "string" + }, + { + "description": "true if network can span multiple zones", + "name": "strechedl2subnet", + "type": "boolean" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + }, + { + "description": "ACL name associated with the VPC network", + "name": "aclname", + "type": "string" + }, + { + "description": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR", + "name": "cidr", + "type": "string" + }, + { + "description": "true if users from subdomains can access the domain level network", + "name": "subdomainaccess", + "type": "boolean" + }, + { + "description": "display text of the network offering the network is created from", + "name": "networkofferingdisplaytext", + "type": "string" + }, + { + "description": "the physical network id", + "name": "physicalnetworkid", + "type": "string" + }, + { + "description": "an optional field, whether to the display the network to the end user or not.", + "name": "displaynetwork", + "type": "boolean" + }, + { + "description": "If the network has redundant routers enabled", + "name": "redundantrouter", + "type": "boolean" + }, + { + "description": "the network's netmask", + "name": "netmask", + "type": "string" + }, + { + "description": "VPC the network belongs to", + "name": "vpcid", + "type": "string" + }, + { + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" + }, + { + "description": "The external id of the network", + "name": "externalid", + "type": "string" + }, + { + "description": "the traffic type of the network", + "name": "traffictype", + "type": "string" + }, + { + "description": "network offering id the network is created from", + "name": "networkofferingid", + "type": "string" + }, + { + "description": "the first DNS for the network", + "name": "dns1", + "type": "string" + }, + { + "description": "list networks that are persistent", + "name": "ispersistent", + "type": "boolean" + }, + { + "description": "Broadcast domain type of the network", + "name": "broadcastdomaintype", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the ID of the Network associated with this private gateway", + "name": "associatednetworkid", + "type": "string" + }, + { + "description": "availability of the network offering the network is created from", + "name": "networkofferingavailability", + "type": "string" + }, + { + "description": "the network domain", + "name": "networkdomain", + "type": "string" + }, + { + "description": "the details of the network", + "name": "details", + "type": "map" + }, + { + "description": "the name of the network", + "name": "name", + "type": "string" + }, + { + "description": "the name of the Network associated with this private gateway", + "name": "associatednetwork", + "type": "string" + }, + { + "description": "the network's gateway", + "name": "gateway", + "type": "string" + }, + { + "description": "ACL Id associated with the VPC network", + "name": "aclid", + "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 account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + } + ], + "type": "list" + }, + { + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" + }, + { + "description": "related to what other network configuration", + "name": "related", + "type": "string" + }, + { + "description": "the second DNS for the network", + "name": "dns2", + "type": "string" + }, + { + "description": "the type of the network", + "name": "type", + "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": "If a network is enabled for 'streched l2 subnet' then represents zones on which network currently spans", + "name": "zonesnetworkspans", + "type": "set" + }, + { + "description": "the project id of the ipaddress", + "name": "projectid", + "type": "string" + }, + { + "description": "The vlan of the network. This parameter is visible to ROOT admins only", + "name": "vlan", + "type": "string" + }, + { + "description": "name of the network offering the network is created from", + "name": "networkofferingname", + "type": "string" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "broadcast uri of the network. This parameter is visible to ROOT admins only", + "name": "broadcasturi", "type": "string" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - } - ], - "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listF5LoadBalancerNetworks,listNetscalerLoadBalancerNetworks,listBrocadeVcsDeviceNetworks", - "response": [ + "description": "The routes for the network to ease adding route in upstream router", + "name": "ip6routes", + "type": "set" + }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the project name of the address", + "name": "project", "type": "string" }, { - "description": "the physical network id", - "name": "physicalnetworkid", + "description": "the ID of the Network associated with this network", + "name": "associatednetworkid", "type": "string" }, { - "description": "the domain id of the network owner", - "name": "domainid", - "type": "string" + "description": "true network requires restart", + "name": "restartrequired", + "type": "boolean" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" + "description": "list networks available for vm deployment", + "name": "canusefordeploy", + "type": "boolean" }, { - "description": "the network domain", - "name": "networkdomain", - "type": "string" + "description": "true if network is system, false otherwise", + "name": "issystem", + "type": "boolean" + }, + { + "description": "true if guest network default egress policy is allow; false if default egress policy is deny", + "name": "egressdefaultpolicy", + "type": "boolean" }, - {}, { "description": "state of the network", "name": "state", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "The routing mode of network offering", + "name": "ip6routing", + "type": "string" }, { - "description": "the network's gateway", - "name": "gateway", + "description": "The internet protocol of network offering", + "name": "internetprotocol", "type": "string" }, { - "description": "the domain name of the network owner", - "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 network CIDR of the guest network configured with IP reservation. It is the summation of CIDR and RESERVED_IP_RANGE", - "name": "networkcidr", + "description": "Name of the VPC to which this network belongs", + "name": "vpcname", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "zone id of the network", + "name": "zoneid", + "type": "string" }, { - "description": "true if network supports specifying ip ranges, false otherwise", - "name": "specifyipranges", - "type": "boolean" + "description": "the id of the network", + "name": "id", + "type": "string" }, { - "description": "the traffic type of the network", - "name": "traffictype", + "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 default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "the list of services", + "name": "service", + "response": [ + { + "description": "the service provider name", + "name": "provider", + "response": [ + { + "description": "services for this provider", + "name": "servicelist", + "type": "list" + }, + { + "description": "the physical network this belongs to", + "name": "physicalnetworkid", + "type": "string" + }, + { + "description": "the destination physical network", + "name": "destinationphysicalnetworkid", + "type": "string" + }, + { + "description": "uuid of the network provider", + "name": "id", + "type": "string" + }, + { + "description": "the provider name", + "name": "name", + "type": "string" + }, + { + "description": "state of the network provider", + "name": "state", + "type": "string" + }, + { + "description": "true if individual services can be enabled/disabled", + "name": "canenableindividualservice", + "type": "boolean" + } + ], + "type": "list" + }, + { + "description": "the service name", + "name": "name", + "type": "string" + }, + { + "description": "the list of capabilities", + "name": "capability", + "response": [ + { + "description": "the capability name", + "name": "name", + "type": "string" + }, + { + "description": "the capability value", + "name": "value", + "type": "string" + }, + { + "description": "can this service capability value can be choosable while creatine network offerings", + "name": "canchooseservicecapability", + "type": "boolean" + } + ], + "type": "list" + } + ], + "type": "list" }, + {}, { - "description": "the first DNS for the network", - "name": "dns1", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "broadcast uri of the network. This parameter is visible to ROOT admins only", - "name": "broadcasturi", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "the displaytext of the network", + "name": "displaytext", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the owner of the network", + "name": "account", "type": "string" }, { - "description": "name of the network offering the network is created from", - "name": "networkofferingname", + "description": "true if network supports specifying ip ranges, false otherwise", + "name": "specifyipranges", + "type": "boolean" + } + ] + }, + { + "description": "Update a supported Kubernetes version", + "isasync": false, + "name": "updateKubernetesSupportedVersion", + "params": [ + { + "description": "the enabled or disabled state of the Kubernetes supported version", + "length": 255, + "name": "state", + "required": true, "type": "string" }, { - "description": "Name of the VPC to which this network belongs", - "name": "vpcname", + "description": "the ID of the Kubernetes supported version", + "length": 255, + "name": "id", + "related": "listKubernetesSupportedVersions,updateKubernetesSupportedVersion", + "required": true, + "type": "uuid" + } + ], + "related": "listKubernetesSupportedVersions", + "response": [ + { + "description": "Name of the Kubernetes supported version", + "name": "name", "type": "string" }, { - "description": "display text of the network offering the network is created from", - "name": "networkofferingdisplaytext", - "type": "string" + "description": "the minimum number of CPUs needed for the Kubernetes supported version", + "name": "mincpunumber", + "type": "integer" }, + {}, { - "description": "The vlan of the network. This parameter is visible to ROOT admins only", - "name": "vlan", + "description": "the id of the zone in which Kubernetes supported version is available", + "name": "zoneid", "type": "string" }, { - "description": "Broadcast domain type of the network", - "name": "broadcastdomaintype", + "description": "the id of the binaries ISO for Kubernetes supported version", + "name": "isoid", "type": "string" }, { - "description": "the details of the network", - "name": "details", - "type": "map" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, { - "description": "the network's IP range not to be used by CloudStack guest VMs and can be used for non CloudStack purposes", - "name": "reservediprange", + "description": "the enabled or disabled state of the Kubernetes supported version", + "name": "state", "type": "string" }, { - "description": "list networks that are persistent", - "name": "ispersistent", + "description": "whether Kubernetes supported version supports Autoscaling", + "name": "supportsautoscaling", "type": "boolean" }, { - "description": "zone id of the network", - "name": "zoneid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the second DNS for the network", - "name": "dns2", + "description": "the name of the zone in which Kubernetes supported version is available", + "name": "zonename", "type": "string" }, { - "description": "If the network has redundant routers enabled", - "name": "redundantrouter", + "description": "whether Kubernetes supported version supports HA, multi-control nodes", + "name": "supportsha", "type": "boolean" }, { - "description": "the network's netmask", - "name": "netmask", - "type": "string" + "description": "the minimum RAM size in MB needed for the Kubernetes supported version", + "name": "minmemory", + "type": "integer" }, { - "description": "true if network can span multiple zones", - "name": "strechedl2subnet", - "type": "boolean" + "description": "Kubernetes semantic version", + "name": "semanticversion", + "type": "string" }, { - "description": "If a network is enabled for 'streched l2 subnet' then represents zones on which network currently spans", - "name": "zonesnetworkspans", - "type": "set" + "description": "the date when this Kubernetes supported version was created", + "name": "created", + "type": "date" }, { - "description": "list networks available for vm deployment", - "name": "canusefordeploy", - "type": "boolean" + "description": "the id of the Kubernetes supported version", + "name": "id", + "type": "string" }, { - "description": "an optional field, whether to the display the network to the end user or not.", - "name": "displaynetwork", - "type": "boolean" + "description": "the state of the binaries ISO for Kubernetes supported version", + "name": "isostate", + "type": "string" }, { - "description": "true if users from subdomains can access the domain level network", - "name": "subdomainaccess", + "description": "the name of the binaries ISO for Kubernetes supported version", + "name": "isoname", + "type": "string" + } + ] + }, + { + "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": "VPC the network belongs to", - "name": "vpcid", + "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,importUnmanagedInstance", + "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,importUnmanagedInstance", + "response": [ + {}, + { + "description": "the ID of the availablility zone for the virtual machine", + "name": "zoneid", "type": "string" }, { - "description": "acl type - access type to the network", - "name": "acltype", + "description": "the ID of the host for the virtual machine", + "name": "hostid", "type": "string" }, { - "description": "the name of the zone the network belongs to", - "name": "zonename", + "description": "State of the Service from LB rule", + "name": "servicestate", "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", "type": "long" }, { - "description": "related to what other network configuration", - "name": "related", + "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", + "type": "long" + }, + { + "description": "the group ID of the virtual machine", + "name": "groupid", "type": "string" }, { - "description": "the project name of the address", - "name": "project", + "description": "the list of nics associated with vm", + "name": "nic", + "response": [ + { + "description": "the isolation uri of the nic", + "name": "isolationuri", + "type": "string" + }, + { + "description": "the type of the nic", + "name": "type", + "type": "string" + }, + { + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" + }, + { + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", + "type": "string" + }, + { + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "the name of the corresponding network", + "name": "networkname", + "type": "string" + }, + { + "description": "the netmask of the nic", + "name": "netmask", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "the IPv6 address of network", + "name": "ip6address", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", + "type": "string" + }, + { + "description": "the ID of the nic", + "name": "id", + "type": "string" + }, + { + "description": "the ID of the corresponding network", + "name": "networkid", + "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": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" + }, + { + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "the traffic type of the nic", + "name": "traffictype", + "type": "string" + }, + { + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", + "type": "string" + }, + { + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "macaddress", + "type": "string" + }, + { + "description": "the gateway of the nic", + "name": "gateway", + "type": "string" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + }, + { + "description": "the ip address of the nic", + "name": "ipaddress", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", "type": "boolean" }, { - "description": "true if network offering is ip conserve mode enabled", - "name": "networkofferingconservemode", - "type": "boolean" + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" }, { - "description": "the list of resource tags associated with network", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", + "type": "string" + }, + { + "description": "the list of resource tags associated", "name": "tags", "response": [ { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "tag value", - "name": "value", + "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 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": "tag key name", + "name": "key", "type": "string" }, { @@ -61652,536 +63615,245 @@ "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "tag value", + "name": "value", "type": "string" } ], - "type": "list" + "type": "set" }, { - "description": "true if network is system, false otherwise", - "name": "issystem", - "type": "boolean" + "description": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" }, - {}, { - "description": "The external id of the network", - "name": "externalid", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "the date this network was created", - "name": "created", - "type": "date" + "description": "the name of the host for the virtual machine", + "name": "hostname", + "type": "string" }, { - "description": "the owner of the network", - "name": "account", + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" + }, + { + "description": "the name of the virtual machine", + "name": "name", "type": "string" }, { - "description": "ACL Id associated with the VPC network", - "name": "aclid", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "ACL name associated with the VPC network", - "name": "aclname", + "description": "the name of the disk offering of the virtual machine", + "name": "diskofferingname", "type": "string" }, { - "description": "availability of the network offering the network is created from", - "name": "networkofferingavailability", + "description": "the ID of the virtual machine", + "name": "id", "type": "string" }, { - "description": "the name of the network", - "name": "name", + "description": "the state of the virtual machine", + "name": "state", "type": "string" }, { - "description": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR", - "name": "cidr", + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "Guest vm Boot Mode", + "name": "bootmode", "type": "string" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", "type": "long" }, { - "description": "the displaytext of the network", - "name": "displaytext", + "description": "Guest vm Boot Type", + "name": "boottype", "type": "string" }, { - "description": "the type of the network", - "name": "type", + "description": "the pool type of the virtual machine", + "name": "pooltype", "type": "string" }, { - "description": "the list of services", - "name": "service", - "response": [ - { - "description": "the service provider name", - "name": "provider", - "response": [ - { - "description": "state of the network provider", - "name": "state", - "type": "string" - }, - { - "description": "services for this provider", - "name": "servicelist", - "type": "list" - }, - { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", - "type": "string" - }, - { - "description": "the destination physical network", - "name": "destinationphysicalnetworkid", - "type": "string" - }, - { - "description": "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" - } - ], - "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" - }, - { - "description": "the service name", - "name": "name", - "type": "string" - } - ], - "type": "list" + "description": "Os type ID of the virtual machine", + "name": "guestosid", + "type": "string" }, { - "description": "network offering id the network is created from", - "name": "networkofferingid", + "description": "the project name of the vm", + "name": "project", "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": "the id of the network", - "name": "id", - "type": "string" - } - ] - }, - { - "description": "Update a supported Kubernetes version", - "isasync": false, - "name": "updateKubernetesSupportedVersion", - "params": [ - { - "description": "the enabled or disabled state of the Kubernetes supported version", - "length": 255, - "name": "state", - "required": true, + "description": "device type of the root volume", + "name": "rootdevicetype", "type": "string" }, { - "description": "the ID of the Kubernetes supported version", - "length": 255, - "name": "id", - "related": "listKubernetesSupportedVersions,updateKubernetesSupportedVersion", - "required": true, - "type": "uuid" - } - ], - "related": "listKubernetesSupportedVersions", - "response": [ + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" + }, { - "description": "the enabled or disabled state of the Kubernetes supported version", - "name": "state", + "description": "the ID of 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 Kubernetes supported version", - "name": "name", - "type": "string" + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" }, - {}, { - "description": "the name of the binaries ISO for Kubernetes supported version", - "name": "isoname", + "description": "OS name of the vm", + "name": "osdisplayname", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", "type": "string" }, - {}, { - "description": "the minimum number of CPUs needed for the Kubernetes supported version", - "name": "mincpunumber", - "type": "integer" + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", + "type": "string" }, { - "description": "whether Kubernetes supported version supports Autoscaling", - "name": "supportsautoscaling", + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", "type": "boolean" }, { - "description": "the id of the zone in which Kubernetes supported version is available", - "name": "zoneid", + "description": "OS type id of the vm", + "name": "ostypeid", "type": "string" }, { - "description": "Kubernetes semantic version", - "name": "semanticversion", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { - "description": "the name of the zone in which Kubernetes supported version is available", + "description": "the name of the availability zone for the virtual machine", "name": "zonename", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", + "type": "string" }, { - "description": "the id of the binaries ISO for Kubernetes supported version", - "name": "isoid", + "description": "ssh key-pairs", + "name": "keypairs", "type": "string" }, { - "description": "the minimum RAM size in MB needed for the Kubernetes supported version", - "name": "minmemory", - "type": "integer" + "description": "the read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" }, { - "description": "the id of the Kubernetes supported version", - "name": "id", - "type": "string" + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" }, { - "description": "whether Kubernetes supported version supports HA, multi-control nodes", - "name": "supportsha", - "type": "boolean" + "description": "the project id of the vm", + "name": "projectid", + "type": "string" }, { - "description": "the state of the binaries ISO for Kubernetes supported version", - "name": "isostate", + "description": "the password (if exists) of the virtual machine", + "name": "password", "type": "string" - } - ] - }, - { - "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,importUnmanagedInstance", - "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,importUnmanagedInstance", - "response": [ - { - "description": "the incoming network traffic on the vm", - "name": "networkkbsread", - "type": "long" + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", + "type": "string" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "list of security groups associated with the virtual machine", - "name": "securitygroup", - "response": [ - { - "description": "the list of ingress rules associated with the security group", - "name": "ingressrule", - "response": [ - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, - { - "description": "account owning the security group rule", - "name": "account", - "type": "string" - }, - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "the 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 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": "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": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the 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": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "tag 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": "tag key name", - "name": "key", - "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 ID of the security group", - "name": "id", - "type": "string" - }, - { - "description": "the domain name of the security group", - "name": "domain", - "type": "string" - }, - { - "description": "the name of the security group", - "name": "name", - "type": "string" - }, + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" + }, + { + "description": "the group name of the virtual machine", + "name": "group", + "type": "string" + }, + { + "description": "list of security groups associated with the virtual machine", + "name": "securitygroup", + "response": [ { "description": "the project name of the group", "name": "project", "type": "string" }, { - "description": "the list of egress rules associated with the security group", - "name": "egressrule", + "description": "the list of ingress rules associated with the security group", + "name": "ingressrule", "response": [ - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, { "description": "the id of the security group rule", "name": "ruleid", "type": "string" }, { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "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 ", @@ -62189,32 +63861,57 @@ "type": "integer" }, { - "description": "the protocol of the security group rule", - "name": "protocol", + "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 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 list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "id of the resource", - "name": "resourceid", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { @@ -62223,8 +63920,13 @@ "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { @@ -62233,45 +63935,139 @@ "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", + "type": "string" + } + ], + "type": "set" + } + ], + "type": "set" + }, + { + "description": "the ID of the security group", + "name": "id", + "type": "string" + }, + { + "description": "the list of egress rules associated with the security group", + "name": "egressrule", + "response": [ + { + "description": "account owning the security group rule", + "name": "account", + "type": "string" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ { "description": "the account associated with the tag", "name": "account", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "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": "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": "tag key name", + "name": "key", + "type": "string" } ], "type": "set" }, { - "description": "the type of the ICMP message response", - "name": "icmptype", + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", "type": "integer" }, { - "description": "account owning the security group rule", - "name": "account", + "description": "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": "the id of the security group rule", + "name": "ruleid", "type": "string" } ], "type": "set" }, { - "description": "the account owning the security group", - "name": "account", - "type": "string" + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" }, { "description": "the description of the security group", @@ -62284,280 +64080,94 @@ "type": "string" }, { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" }, { "description": "the project id of the group", "name": "projectid", "type": "string" - } - ], - "type": "set" - }, - { - "description": "the write (bytes) of disk on the vm", - "name": "diskkbswrite", - "type": "long" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", - "type": "string" - }, - { - "description": "the project name of the vm", - "name": "project", - "type": "string" - }, - { - "description": "the project id of the vm", - "name": "projectid", - "type": "string" - }, - { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", - "type": "string" - }, - { - "description": "State of the Service from LB rule", - "name": "servicestate", - "type": "string" - }, - { - "description": "the password (if exists) of the virtual machine", - "name": "password", - "type": "string" - }, - { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "OS type id of the vm", - "name": "ostypeid", - "type": "string" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the vgpu type used by the virtual machine", - "name": "vgpu", - "type": "string" - }, - { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" - }, - { - "description": "the list of nics associated with vm", - "name": "nic", - "response": [ - { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "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 cidr of IPv6 network", - "name": "ip6cidr", - "type": "string" - }, - { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "true if nic is default, false otherwise", - "name": "macaddress", - "type": "string" - }, - { - "description": "the IPv6 address of network", - "name": "ip6address", - "type": "string" - }, - { - "description": "the ID of the corresponding network", - "name": "networkid", - "type": "string" - }, - { - "description": "the netmask of the nic", - "name": "netmask", - "type": "string" - }, - { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - }, - { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" - }, - { - "description": "the 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 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": "the name of the corresponding network", - "name": "networkname", - "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": "Type of adapter if available", - "name": "adaptertype", - "type": "string" - }, - { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", - "type": "string" }, { - "description": "the type of the nic", - "name": "type", + "description": "the name of the security group", + "name": "name", "type": "string" }, { - "description": "the ID of the nic", - "name": "id", + "description": "the domain name of the security group", + "name": "domain", "type": "string" }, { - "description": "the ip address of the nic", - "name": "ipaddress", - "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": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "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" + } + ], + "type": "set" }, { - "description": "the gateway of the nic", - "name": "gateway", + "description": "the account owning the security group", + "name": "account", "type": "string" } ], "type": "set" }, - { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" - }, - { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", - "type": "string" - }, - { - "description": "the state of the virtual machine", - "name": "state", - "type": "string" - }, - { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", - "type": "string" - }, - { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", - "type": "string" - }, - { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", - "type": "string" - }, - { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", - "type": "string" - }, - { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" - }, - { - "description": "the pool type of the virtual machine", - "name": "pooltype", - "type": "string" - }, - { - "description": "Guest vm Boot Mode", - "name": "bootmode", - "type": "string" - }, - {}, - { - "description": "the write (io) of disk on the vm", - "name": "diskiowrite", - "type": "long" + { + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" }, { "description": "the date when this virtual machine was created", @@ -62565,19 +64175,9 @@ "type": "date" }, { - "description": "the read (io) of disk on the vm", - "name": "diskioread", - "type": "long" - }, - { - "description": "the target memory in vm", - "name": "memorytargetkbs", - "type": "long" - }, - { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", - "type": "string" + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" }, { "description": "the amount of the vm's CPU currently used", @@ -62585,322 +64185,238 @@ "type": "string" }, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, - {}, { - "description": "OS name of the vm", - "name": "osdisplayname", + "description": "the user's ID who deployed the virtual machine", + "name": "userid", "type": "string" }, { - "description": "the group ID of the virtual machine", - "name": "groupid", + "description": "the account associated with the virtual machine", + "name": "account", "type": "string" }, { - "description": "the ID of the availablility zone for the virtual machine", - "name": "zoneid", - "type": "string" + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" }, { - "description": "the internal memory that's free in vm or zero if it can not be calculated", - "name": "memoryintfreekbs", + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", "type": "long" }, { - "description": "the user's name who deployed the virtual machine", - "name": "username", - "type": "string" - }, - { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", - "type": "boolean" - }, - { - "description": "ssh key-pair", - "name": "keypair", - "type": "string" + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", - "type": "string" + "description": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" }, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", - "type": "string" + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, {}, { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, + {}, { - "description": "the ID of the virtual machine", - "name": "id", + "description": "the ID of the disk offering of the virtual machine", + "name": "diskofferingid", "type": "string" }, { - "description": "the outgoing network traffic on the host", - "name": "networkkbswrite", - "type": "long" - }, - { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" - }, - { - "description": "device type of the root volume", - "name": "rootdevicetype", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" - }, - { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { - "description": "Guest vm Boot Type", - "name": "boottype", + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", "type": "string" }, { - "description": "the ID of the disk offering of the virtual machine", - "name": "diskofferingid", + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", "type": "string" }, { - "description": "the number of cpu this virtual machine is running with", - "name": "cpunumber", - "type": "integer" - }, - { - "description": "the read (bytes) of disk on the vm", - "name": "diskkbsread", + "description": "the memory used by the VM in KiB", + "name": "memorykbs", "type": "long" }, { - "description": "the list of resource tags associated", - "name": "tags", + "description": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", "response": [ { - "description": "the account associated with the tag", - "name": "account", + "description": "the name of the affinity group", + "name": "name", "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 ID of the domain associated with the tag", - "name": "domainid", + "description": "the type of the affinity group", + "name": "type", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the ID of the affinity group", + "name": "id", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the domain ID of the affinity group", + "name": "domainid", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the description of the affinity group", + "name": "description", "type": "string" }, { - "description": "the domain associated with the tag", + "description": "the domain name of the affinity group", "name": "domain", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the project ID of the affinity group", + "name": "projectid", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the account owning the affinity group", + "name": "account", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the project name of the affinity group", + "name": "project", "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 backup offering of the virtual machine", + "name": "backupofferingid", + "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" }, { - "description": "the memory used by the vm", - "name": "memorykbs", + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", "type": "long" }, { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" - }, - { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" - }, - { - "description": "the group name of the virtual machine", - "name": "group", + "description": "the user's name who deployed the virtual machine", + "name": "username", "type": "string" - }, + } + ] + }, + { + "description": "Creates a guest network IPv6 prefix.", + "isasync": true, + "name": "createGuestNetworkIpv6Prefix", + "params": [ { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" + "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 account associated with the virtual machine", - "name": "account", + "description": "The /56 or higher IPv6 CIDR for network prefix.", + "length": 255, + "name": "prefix", + "required": true, "type": "string" - }, - { - "description": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" - }, + } + ], + "related": "listGuestNetworkIpv6Prefixes", + "response": [ + {}, { - "description": "the name of the host for the virtual machine", - "name": "hostname", - "type": "string" + "description": "count of the total IPv6 subnets for the prefix.", + "name": "totalsubnets", + "type": "integer" }, { - "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": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "id of zone to which the IPv6 prefix belongs to.", + "name": "zoneid", "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", + "description": "id of the guest IPv6 prefix", + "name": "id", "type": "string" }, { - "description": "the name of the virtual machine", - "name": "name", - "type": "string" + "description": "count of the used IPv6 subnets for the prefix.", + "name": "usedsubnets", + "type": "integer" }, { - "description": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", - "response": [ - { - "description": "the type of the affinity group", - "name": "type", - "type": "string" - }, - { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" - }, - { - "description": "the 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 ID of the affinity group", - "name": "id", - "type": "string" - }, - { - "description": "the project name of the affinity group", - "name": "project", - "type": "string" - }, - { - "description": "the account owning the affinity group", - "name": "account", - "type": "string" - }, - { - "description": "the project ID of the affinity group", - "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 name of the template for the virtual machine", - "name": "templatename", + "description": "guest IPv6 prefix", + "name": "prefix", "type": "string" }, { - "description": "the speed of each cpu", - "name": "cpuspeed", + "description": "count of the available IPv6 subnets for the prefix.", + "name": "availablesubnets", "type": "integer" }, { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", - "type": "string" - }, - { - "description": "the name of the disk offering of the virtual machine", - "name": "diskofferingname", - "type": "string" + "description": " date when this IPv6 prefix was created.", + "name": "created", + "type": "date" } - ] + ], + "since": "4.17.0.0" }, { "description": " delete a Palo Alto firewall device", @@ -62917,28 +64433,28 @@ } ], "response": [ - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - }, - {}, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, - {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, + {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - } + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + }, + {} ] }, { @@ -62957,25 +64473,25 @@ ], "response": [ { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" }, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, {} ] @@ -62985,13 +64501,6 @@ "isasync": false, "name": "listDeploymentPlanners", "params": [ - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - }, { "description": "", "length": 255, @@ -63005,26 +64514,33 @@ "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": "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 current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" } ] }, @@ -63033,13 +64549,6 @@ "isasync": false, "name": "createRole", "params": [ - { - "description": "Creates a role with this unique name", - "length": 255, - "name": "name", - "required": true, - "type": "string" - }, { "description": "The description of the role", "length": 255, @@ -63048,10 +64557,10 @@ "type": "string" }, { - "description": "The type of the role, valid options are: Admin, ResourceAdmin, DomainAdmin, User", + "description": "Creates a role with this unique name", "length": 255, - "name": "type", - "required": false, + "name": "name", + "required": true, "type": "string" }, { @@ -63061,46 +64570,53 @@ "related": "createRole,importRole,listRoles,updateRole", "required": false, "type": "uuid" + }, + { + "description": "The type of the role, valid options are: Admin, ResourceAdmin, DomainAdmin, User", + "length": 255, + "name": "type", + "required": false, + "type": "string" } ], "related": "importRole,listRoles,updateRole", "response": [ - { - "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 name of the role", - "name": "name", + "description": "the description of the role", + "name": "description", "type": "string" }, {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "true if role is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, + {}, { "description": "the ID of the role", "name": "id", "type": "string" }, { - "description": "true if role is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, - {}, { "description": "the type of the role", "name": "type", "type": "string" + }, + { + "description": "the name of the role", + "name": "name", + "type": "string" } ], "since": "4.9.0" @@ -63120,17 +64636,13 @@ } ], "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", @@ -63141,7 +64653,11 @@ "name": "displaytext", "type": "string" }, - {} + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + } ] }, { @@ -63153,77 +64669,116 @@ "description": "the host ID", "length": 255, "name": "id", - "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost,addBaremetalHost", + "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost", "required": true, "type": "uuid" } ], - "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,reconnectHost,addBaremetalHost", + "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,reconnectHost", "response": [ { - "description": "capabilities of the host", - "name": "capabilities", + "description": "the name of the host", + "name": "name", "type": "string" }, { - "description": "the host out-of-band management information", - "name": "outofbandmanagement", - "type": "outofbandmanagementresponse" - }, - { - "description": "the Zone name of the host", - "name": "zonename", - "type": "string" + "description": "GPU cards present in the host", + "name": "gpugroup", + "response": [ + { + "description": "GPU cards present in the host", + "name": "gpugroupname", + "type": "string" + }, + { + "description": "the list of enabled vGPUs", + "name": "vgpu", + "response": [ + { + "description": "Maximum X resolution per display", + "name": "maxresolutionx", + "type": "long" + }, + { + "description": "Model Name of vGPU", + "name": "vgputype", + "type": "string" + }, + { + "description": "Maximum no. of vgpu per gpu card (pgpu)", + "name": "maxvgpuperpgpu", + "type": "long" + }, + { + "description": "Maximum Y resolution per display", + "name": "maxresolutiony", + "type": "long" + }, + { + "description": "Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type", + "name": "remainingcapacity", + "type": "long" + }, + { + "description": "Maximum vgpu can be created with this vgpu type on the given gpu group", + "name": "maxcapacity", + "type": "long" + }, + { + "description": "Video RAM for this vGPU type", + "name": "videoram", + "type": "long" + }, + { + "description": "Maximum displays per user", + "name": "maxheads", + "type": "long" + } + ], + "type": "list" + } + ], + "type": "list" }, { - "description": "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 host type", - "name": "type", - "type": "type" + "description": "the host out-of-band management information", + "name": "outofbandmanagement", + "type": "outofbandmanagementresponse" }, { - "description": "events available for the host", - "name": "events", + "description": "the Pod ID of the host", + "name": "podid", "type": "string" }, { - "description": "the amount of the host's CPU currently allocated in MHz", - "name": "cpuallocatedvalue", + "description": "the outgoing network traffic on the host", + "name": "networkkbswrite", "type": "long" }, - { - "description": "the 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 admin that annotated this host", - "name": "username", + "description": "the cluster ID of the host", + "name": "clusterid", "type": "string" }, { - "description": "the name of the host", - "name": "name", + "description": "the cluster name of the host", + "name": "clustername", "type": "string" }, { - "description": "the incoming network traffic on the host", - "name": "networkkbsread", - "type": "long" - }, - { - "description": "the cpu average load on the host", - "name": "cpuloadaverage", - "type": "double" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { "description": "the state of the host", @@ -63231,18 +64786,18 @@ "type": "status" }, { - "description": "true if the host is disconnected. False otherwise.", - "name": "disconnected", - "type": "date" + "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", + "name": "memorytotal", + "type": "long" }, { - "description": "the outgoing network traffic on the host", - "name": "networkkbswrite", - "type": "long" + "description": "the amount of the host's CPU currently used", + "name": "cpuused", + "type": "string" }, { - "description": "the OS category name of the host", - "name": "oscategoryname", + "description": "the resource state of the host", + "name": "resourcestate", "type": "string" }, { @@ -63251,223 +64806,191 @@ "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "true if this host is suitable(has enough capacity and satisfies all conditions like hosttags, max guests vm limit etc) to migrate a VM to it , false otherwise", + "name": "suitableformigration", + "type": "boolean" }, { - "description": "the IP address of the host", - "name": "ipaddress", - "type": "string" + "description": "the host's currently allocated disk size", + "name": "disksizeallocated", + "type": "long" }, { - "description": "the amount of the host's CPU currently allocated in percentage", - "name": "cpuallocatedpercentage", + "description": "the Zone name of the host", + "name": "zonename", "type": "string" }, { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", - "type": "long" + "description": "the cpu average load on the host", + "name": "cpuloadaverage", + "type": "double" }, { - "description": "the date and time the host was created", - "name": "created", + "description": "the last time this host was annotated", + "name": "lastannotated", "type": "date" }, + {}, + {}, { - "description": "the OS category ID of the host", - "name": "oscategoryid", - "type": "string" + "description": "true if the host is disconnected. False otherwise.", + "name": "disconnected", + "type": "date" }, { - "description": "comma-separated list of tags for the host", - "name": "hosttags", + "description": "the amount of the host's memory after applying the mem.overprovisioning.factor", + "name": "memorywithoverprovisioning", "type": "string" }, { - "description": "the resource state of the host", - "name": "resourcestate", + "description": "the number of CPU sockets on the host", + "name": "cpusockets", + "type": "integer" + }, + { + "description": "the amount of the host's CPU currently allocated in percentage", + "name": "cpuallocatedpercentage", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the management server ID of the host", + "name": "managementserverid", + "type": "string" }, { - "description": "true if local storage is active, false otherwise", - "name": "islocalstorageactive", + "description": "true if the host has capability to support UEFI boot", + "name": "ueficapability", "type": "boolean" }, { - "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", - "name": "cpuallocatedwithoverprovisioning", - "type": "string" + "description": "the date and time the host was created", + "name": "created", + "type": "date" }, { - "description": "the amount of the host's CPU currently used", - "name": "cpuused", + "description": "the host version", + "name": "version", "type": "string" }, { - "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": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", - "name": "memorytotal", + "description": "the CPU speed of the host", + "name": "cpuspeed", "type": "long" }, { - "description": "GPU cards present in the host", - "name": "gpugroup", - "response": [ - { - "description": "the list of enabled vGPUs", - "name": "vgpu", - "response": [ - { - "description": "Video RAM for this vGPU type", - "name": "videoram", - "type": "long" - }, - { - "description": "Maximum Y resolution per display", - "name": "maxresolutiony", - "type": "long" - }, - { - "description": "Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type", - "name": "remainingcapacity", - "type": "long" - }, - { - "description": "Maximum vgpu can be created with this vgpu type on the given gpu group", - "name": "maxcapacity", - "type": "long" - }, - { - "description": "Maximum displays per user", - "name": "maxheads", - "type": "long" - }, - { - "description": "Maximum no. of vgpu per gpu card (pgpu)", - "name": "maxvgpuperpgpu", - "type": "long" - }, - { - "description": "Maximum X resolution per display", - "name": "maxresolutionx", - "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 is Ha host (dedicated to vms started by HA process; false otherwise", + "name": "hahost", + "type": "boolean" }, { - "description": "the Zone ID of the host", - "name": "zoneid", + "description": "the amount of the host's CPU currently allocated", + "name": "cpuallocated", "type": "string" }, { - "description": "true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise", - "name": "hasenoughcapacity", + "description": "events available for the host", + "name": "events", + "type": "string" + }, + { + "description": "the IP address of the host", + "name": "ipaddress", + "type": "string" + }, + { + "description": "true if local storage is active, false otherwise", + "name": "islocalstorageactive", "type": "boolean" }, + { + "description": "the hypervisor version", + "name": "hypervisorversion", + "type": "string" + }, { "description": "the date and time the host was removed", "name": "removed", "type": "date" }, { - "description": "the total disk size of the host", - "name": "disksizetotal", - "type": "long" + "description": "comma-separated list of tags for the host", + "name": "hosttags", + "type": "string" }, { - "description": "the last annotation set on this host by an admin", - "name": "annotation", + "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 CPU number of the host", + "name": "cpunumber", + "type": "integer" }, { - "description": "the CPU speed of the host", - "name": "cpuspeed", - "type": "long" + "description": "the last annotation set on this host by an admin", + "name": "annotation", + "type": "string" }, { - "description": "the amount of the host's memory after applying the mem.overprovisioning.factor", - "name": "memorywithoverprovisioning", + "description": "the OS category name of the host", + "name": "oscategoryname", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the amount of the host's CPU currently allocated in MHz", + "name": "cpuallocatedvalue", + "type": "long" }, { - "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise", - "name": "hahost", - "type": "boolean" + "description": "the Zone ID of the host", + "name": "zoneid", + "type": "string" }, { - "description": "Host details in key/value pairs.", - "name": "details", - "type": "map" + "description": "true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise", + "name": "hasenoughcapacity", + "type": "boolean" }, { - "description": "the 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 hypervisor version", - "name": "hypervisorversion", + "description": "the admin that annotated this host", + "name": "username", "type": "string" }, { - "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor", - "name": "cpuwithoverprovisioning", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "true if the host has capability to support UEFI boot", - "name": "ueficapability", - "type": "boolean" + "description": "the host HA information information", + "name": "hostha", + "type": "hostharesponse" }, { - "description": "the last time this host was annotated", - "name": "lastannotated", - "type": "date" + "description": "the Pod name of the host", + "name": "podname", + "type": "string" }, { - "description": "true if this host is suitable(has enough capacity and satisfies all conditions like hosttags, max guests vm limit etc) to migrate a VM to it , false otherwise", - "name": "suitableformigration", - "type": "boolean" + "description": "the OS category ID of the host", + "name": "oscategoryid", + "type": "string" }, { - "description": "the Pod ID of the host", - "name": "podid", - "type": "string" + "description": "the incoming network traffic on the host", + "name": "networkkbsread", + "type": "long" }, { "description": "the date and time the host was last pinged", @@ -63475,50 +64998,43 @@ "type": "date" }, { - "description": "the management server ID of the host", - "name": "managementserverid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, - {}, { - "description": "the amount of the host's CPU currently allocated", - "name": "cpuallocated", + "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor", + "name": "cpuwithoverprovisioning", "type": "string" }, { - "description": "the amount of the host's memory currently allocated in percentage", - "name": "memoryallocatedpercentage", + "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", + "name": "cpuallocatedwithoverprovisioning", "type": "string" }, { - "description": "the amount of the host's memory currently allocated", - "name": "memoryallocated", - "type": "long" + "description": "the host hypervisor", + "name": "hypervisor", + "type": "hypervisortype" }, { - "description": "the cluster ID of the host", - "name": "clusterid", - "type": "string" + "description": "the total disk size of the host", + "name": "disksizetotal", + "type": "long" }, { - "description": "the CPU number of the host", - "name": "cpunumber", - "type": "integer" + "description": "the host type", + "name": "type", + "type": "type" }, { - "description": "the host version", - "name": "version", + "description": "the ID of the host", + "name": "id", "type": "string" }, - {}, - { - "description": "the amount of the host's memory currently used", - "name": "memoryused", - "type": "long" - }, { - "description": "the ID of the host", - "name": "id", + "description": "capabilities of the host", + "name": "capabilities", "type": "string" } ] @@ -63537,27 +65053,27 @@ } ], "response": [ + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + }, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - {}, - { - "description": "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" - }, {} ] }, @@ -63577,21 +65093,21 @@ "related": "", "response": [ { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "Volume iSCSI Name", + "name": "volumeiScsiName", + "type": "string" }, {}, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, + {}, { - "description": "Volume iSCSI Name", - "name": "volumeiScsiName", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ] }, @@ -63601,12 +65117,18 @@ "name": "getUploadParamsForVolume", "params": [ { - "description": "the ID of the disk offering. This must be a custom sized offering since during upload of volume/template size is unknown.", + "description": "an optional accountName. Must be used with domainId.", "length": 255, - "name": "diskofferingid", - "related": "createDiskOffering,listDiskOfferings", + "name": "account", "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.", + "length": 255, + "name": "checksum", + "required": false, + "type": "string" }, { "description": "the name of the volume/template", @@ -63616,11 +65138,20 @@ "type": "string" }, { - "description": "an optional accountName. Must be used with domainId.", + "description": "the ID of the zone the volume/template is to be hosted on", "length": 255, - "name": "account", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": true, + "type": "uuid" + }, + { + "description": "the ID of the disk offering. This must be a custom sized offering since during upload of volume/template size is unknown.", + "length": 255, + "name": "diskofferingid", + "related": "createDiskOffering,listDiskOfferings", "required": false, - "type": "string" + "type": "uuid" }, { "description": "Upload volume/template for the project", @@ -63630,13 +65161,6 @@ "required": false, "type": "uuid" }, - { - "description": "the format for the volume/template. Possible values include QCOW2, OVA, and VHD.", - "length": 255, - "name": "format", - "required": true, - "type": "string" - }, { "description": "Image store uuid", "length": 255, @@ -63645,10 +65169,10 @@ "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 format for the volume/template. Possible values include QCOW2, OVA, and VHD.", "length": 255, - "name": "checksum", - "required": false, + "name": "format", + "required": true, "type": "string" }, { @@ -63658,14 +65182,6 @@ "related": "listDomainChildren,listDomains", "required": false, "type": "uuid" - }, - { - "description": "the ID of the zone the volume/template is to be hosted on", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": true, - "type": "uuid" } ], "related": "getUploadParamsForTemplate,getUploadParamsForIso", @@ -63675,15 +65191,16 @@ "name": "jobid", "type": "string" }, + {}, { - "description": "signature to be sent in the POST request.", - "name": "signature", + "description": "encrypted data to be sent in the POST request.", + "name": "metadata", "type": "string" }, { - "description": "the template/volume ID", - "name": "id", - "type": "uuid" + "description": "the timestamp after which the signature expires", + "name": "expires", + "type": "string" }, {}, { @@ -63692,8 +65209,8 @@ "type": "integer" }, { - "description": "encrypted data to be sent in the POST request.", - "name": "metadata", + "description": "signature to be sent in the POST request.", + "name": "signature", "type": "string" }, { @@ -63701,11 +65218,10 @@ "name": "postURL", "type": "url" }, - {}, { - "description": "the timestamp after which the signature expires", - "name": "expires", - "type": "string" + "description": "the template/volume ID", + "name": "id", + "type": "uuid" } ], "since": "4.6.0" @@ -63716,26 +65232,27 @@ "name": "updateAutoScaleVmGroup", "params": [ { - "description": "the maximum number of members in the vmgroup, The number of instances in the vm group will be equal to or less than this number.", + "description": "an optional field, whether to the display the group to the end user or not", "length": 255, - "name": "maxmembers", + "name": "fordisplay", "required": false, - "type": "integer" + "since": "4.4", + "type": "boolean" }, { - "description": "the frequency at which the conditions have to be evaluated", + "description": "list of scaledown autoscale policies", "length": 255, - "name": "interval", + "name": "scaledownpolicyids", + "related": "listAutoScalePolicies,updateAutoScalePolicy", "required": false, - "type": "integer" + "type": "list" }, { - "description": "list of scaleup autoscale policies", + "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": "scaleuppolicyids", - "related": "listAutoScalePolicies,updateAutoScalePolicy", + "name": "minmembers", "required": false, - "type": "list" + "type": "integer" }, { "description": "the ID of the autoscale group", @@ -63746,12 +65263,11 @@ "type": "uuid" }, { - "description": "list of scaledown autoscale policies", + "description": "the frequency at which the conditions have to be evaluated", "length": 255, - "name": "scaledownpolicyids", - "related": "listAutoScalePolicies,updateAutoScalePolicy", + "name": "interval", "required": false, - "type": "list" + "type": "integer" }, { "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", @@ -63762,46 +65278,47 @@ "type": "string" }, { - "description": "an optional field, whether to the display the group to the end user or not", + "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": "fordisplay", + "name": "maxmembers", "required": false, - "since": "4.4", - "type": "boolean" + "type": "integer" }, { - "description": "the minimum number of members in the vmgroup, the number of instances in the vm group will be equal to or more than this number.", + "description": "list of scaleup autoscale policies", "length": 255, - "name": "minmembers", + "name": "scaleuppolicyids", + "related": "listAutoScalePolicies,updateAutoScalePolicy", "required": false, - "type": "integer" + "type": "list" } ], "related": "enableAutoScaleVmGroup,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": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "list of scaleup autoscale policies", - "name": "scaleuppolicies", - "type": "list" + "description": "the autoscale vm group ID", + "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": "is group for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, - { - "description": "the current state of the AutoScale Vm Group", - "name": "state", - "type": "string" + { + "description": "list of scaleup autoscale policies", + "name": "scaleuppolicies", + "type": "list" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the load balancer rule ID", + "name": "lbruleid", "type": "string" }, { @@ -63810,40 +65327,45 @@ "type": "string" }, { - "description": "is group 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 domain name of the vm profile", + "name": "domain", + "type": "string" }, { - "description": "the project id vm profile", - "name": "projectid", + "description": "the autoscale profile that contains information about the vms in the vm group.", + "name": "vmprofileid", "type": "string" }, { - "description": "list of scaledown autoscale policies", - "name": "scaledownpolicies", - "type": "list" + "description": "the current state of the AutoScale Vm Group", + "name": "state", + "type": "string" }, { "description": "the account owning the instance group", "name": "account", "type": "string" }, - {}, { - "description": "the autoscale vm group ID", - "name": "id", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, { - "description": "the domain name of the vm profile", - "name": "domain", - "type": "string" + "description": "the maximum number of members in the vmgroup, The number of instances in the vm group will be equal to or less than this number.", + "name": "maxmembers", + "type": "int" + }, + { + "description": "list of scaledown autoscale policies", + "name": "scaledownpolicies", + "type": "list" + }, + { + "description": "the minimum number of members in the vmgroup, the number of instances in the vm group will be equal to or more than this number.", + "name": "minmembers", + "type": "int" }, { "description": "the domain ID of the vm profile", @@ -63851,20 +65373,14 @@ "type": "string" }, { - "description": "the load balancer rule ID", - "name": "lbruleid", + "description": "the project id vm profile", + "name": "projectid", "type": "string" }, - {}, { "description": "the frequency at which the conditions have to be evaluated", "name": "interval", "type": "int" - }, - { - "description": "the autoscale profile that contains information about the vms in the vm group.", - "name": "vmprofileid", - "type": "string" } ] }, @@ -63873,14 +65389,6 @@ "isasync": true, "name": "updateAutoScaleVmProfile", "params": [ - { - "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": "the ID of the autoscale vm profile", "length": 255, @@ -63889,6 +65397,14 @@ "required": true, "type": "uuid" }, + { + "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, @@ -63905,12 +65421,12 @@ "type": "map" }, { - "description": "the ID of the user used to launch and destroy the VMs", + "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", "length": 255, - "name": "autoscaleuserid", - "related": "createUser,disableUser,enableUser,getUser,listUsers,lockUser,updateUser", + "name": "customid", "required": false, - "type": "uuid" + "since": "4.4", + "type": "string" }, { "description": "the time allowed for existing connections to get closed before a vm is destroyed", @@ -63920,19 +65436,30 @@ "type": "integer" }, { - "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", + "description": "the template of the auto deployed virtual machine", "length": 255, - "name": "customid", + "name": "templateid", + "related": "listIsos,registerIso,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", "required": false, - "since": "4.4", - "type": "string" + "type": "uuid" } ], "related": "createAutoScaleVmProfile,listAutoScaleVmProfiles", "response": [ { - "description": "the service offering to be used while deploying a virtual machine", - "name": "serviceofferingid", + "description": "the availability zone to be used while deploying a virtual machine", + "name": "zoneid", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {}, + { + "description": "the domain ID of the vm profile", + "name": "domainid", "type": "string" }, { @@ -63941,51 +65468,50 @@ "type": "boolean" }, { - "description": "the template to be used while deploying a virtual machine", - "name": "templateid", + "description": "the autoscale vm profile ID", + "name": "id", "type": "string" }, - {}, { - "description": "the time allowed for existing connections to get closed before a vm is destroyed", - "name": "destroyvmgraceperiod", - "type": "integer" + "description": "the project name of the vm profile", + "name": "project", + "type": "string" }, { - "description": "the availability zone to be used while deploying a virtual machine", - "name": "zoneid", + "description": "the account owning the instance group", + "name": "account", "type": "string" }, { - "description": "the domain name of the vm profile", - "name": "domain", + "description": "parameters other than zoneId/serviceOfferringId/templateId to be used while deploying a virtual machine", + "name": "otherdeployparams", "type": "string" }, {}, { - "description": "the project id vm profile", - "name": "projectid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the domain ID of the vm profile", - "name": "domainid", + "description": "the template to be used while deploying a virtual machine", + "name": "templateid", "type": "string" }, { - "description": "the autoscale vm profile ID", - "name": "id", + "description": "the service offering to be used while deploying a virtual machine", + "name": "serviceofferingid", "type": "string" }, + {}, { - "description": "parameters other than zoneId/serviceOfferringId/templateId to be used while deploying a virtual machine", - "name": "otherdeployparams", + "description": "the project id vm profile", + "name": "projectid", "type": "string" }, - {}, { - "description": "the account owning the instance group", - "name": "account", + "description": "the domain name of the vm profile", + "name": "domain", "type": "string" }, { @@ -63993,22 +65519,12 @@ "name": "autoscaleuserid", "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", + "description": "the time allowed for existing connections to get closed before a vm is destroyed", + "name": "destroyvmgraceperiod", "type": "integer" - }, - { - "description": "the project name of the vm profile", - "name": "project", - "type": "string" - }, - {} + } ] }, { @@ -64027,91 +65543,91 @@ ], "related": "listAutoScaleVmGroups", "response": [ - { - "description": "list of scaleup autoscale policies", - "name": "scaleuppolicies", - "type": "list" - }, { "description": "the maximum number of members in the vmgroup, The number of instances in the vm group will be equal to or less than this number.", "name": "maxmembers", "type": "int" }, - {}, { - "description": "list of scaledown autoscale policies", - "name": "scaledownpolicies", - "type": "list" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the minimum number of members in the vmgroup, the number of instances in the vm group will be equal to or more than this number.", - "name": "minmembers", - "type": "int" + "description": "the autoscale vm group ID", + "name": "id", + "type": "string" }, { - "description": "the project name of the vm profile", - "name": "project", + "description": "the account owning the instance group", + "name": "account", "type": "string" }, { - "description": "the autoscale profile that contains information about the vms in the vm group.", - "name": "vmprofileid", + "description": "the load balancer rule ID", + "name": "lbruleid", "type": "string" }, { - "description": "the domain name of the vm profile", - "name": "domain", + "description": "the current state of the AutoScale Vm Group", + "name": "state", "type": "string" }, { - "description": "the load balancer rule ID", - "name": "lbruleid", - "type": "string" + "description": "list of scaleup autoscale policies", + "name": "scaleuppolicies", + "type": "list" }, { - "description": "the frequency at which the conditions have to be evaluated", - "name": "interval", + "description": "the minimum number of members in the vmgroup, the number of instances in the vm group will be equal to or more than this number.", + "name": "minmembers", "type": "int" }, { - "description": "the autoscale vm group ID", - "name": "id", + "description": "the autoscale profile that contains information about the vms in the vm group.", + "name": "vmprofileid", "type": "string" }, { - "description": "the account owning the instance group", - "name": "account", + "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", - "type": "string" + "description": "the frequency at which the conditions have to be evaluated", + "name": "interval", + "type": "int" }, { - "description": "the domain ID of the vm profile", - "name": "domainid", + "description": "the project id vm profile", + "name": "projectid", "type": "string" }, + {}, { "description": "is group 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": "list of scaledown autoscale policies", + "name": "scaledownpolicies", + "type": "list" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, {}, { - "description": "the project id vm profile", - "name": "projectid", + "description": "the domain name of the vm profile", + "name": "domain", "type": "string" }, { - "description": "the current state of the AutoScale Vm Group", - "name": "state", + "description": "the project name of the vm profile", + "name": "project", "type": "string" } ] @@ -64131,23 +65647,23 @@ } ], "response": [ - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {}, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, {}, - { - "description": "the 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", @@ -64156,70 +65672,124 @@ ] }, { - "description": "List the virtual machines owned by the account.", + "description": "Lists guest network IPv6 prefixes", "isasync": false, - "name": "listVirtualMachines", + "name": "listGuestNetworkIpv6Prefixes", "params": [ { - "description": "the user ID that created the VM and is under the account that owns the VM", + "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": "the storage ID where vm's volumes belong to", + "description": "", "length": 255, - "name": "storageid", - "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "the security group ID", + "description": "", "length": 255, - "name": "securitygroupid", - "related": "createSecurityGroup", + "name": "pagesize", "required": false, - "since": "4.15", - "type": "uuid" + "type": "integer" }, { - "description": "list objects by project", + "description": "UUID of the IPv6 prefix.", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", + "name": "id", + "related": "listGuestNetworkIpv6Prefixes", "required": false, "type": "uuid" }, { - "description": "list by network type; true if need to list vms using Virtual Network, false otherwise", + "description": "UUID of zone to which the IPv6 prefix belongs to.", "length": 255, - "name": "forvirtualnetwork", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, - "type": "boolean" + "type": "uuid" + } + ], + "related": "", + "response": [ + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the group ID", + "description": "count of the used IPv6 subnets for the prefix.", + "name": "usedsubnets", + "type": "integer" + }, + { + "description": "id of the guest IPv6 prefix", + "name": "id", + "type": "string" + }, + {}, + { + "description": "guest IPv6 prefix", + "name": "prefix", + "type": "string" + }, + { + "description": " date when this IPv6 prefix was created.", + "name": "created", + "type": "date" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "count of the total IPv6 subnets for the prefix.", + "name": "totalsubnets", + "type": "integer" + }, + {}, + { + "description": "count of the available IPv6 subnets for the prefix.", + "name": "availablesubnets", + "type": "integer" + }, + { + "description": "id of zone to which the IPv6 prefix belongs to.", + "name": "zoneid", + "type": "string" + } + ], + "since": "4.17.0" + }, + { + "description": "List the virtual machines owned by the account.", + "isasync": false, + "name": "listVirtualMachines", + "params": [ + { + "description": "list by the backup offering", "length": 255, - "name": "groupid", - "related": "createInstanceGroup", + "name": "backupofferingid", "required": false, + "since": "4.17", "type": "uuid" }, { - "description": "flag to display the resource icon for VMs", + "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": "showicon", + "name": "state", "required": false, - "since": "4.16.0.0", - "type": "boolean" + "type": "string" }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, @@ -64232,103 +65802,108 @@ "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 only resources belonging to the domain specified", + "description": "the user ID that created the VM and is under the account that owns the VM", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", + "name": "userid", + "related": "createUser,disableUser,enableUser,getUser,listUsers,lockUser,updateUser", "required": false, "type": "uuid" }, { - "description": "list vms by vpc", + "description": "the availability zone ID", "length": 255, - "name": "vpcid", - "related": "listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, "type": "uuid" }, { - "description": "list vms by ssh keypair name", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "keypair", + "name": "domainid", + "related": "listDomainChildren,listDomains", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "list by network id", + "description": "list vms by iso", "length": 255, - "name": "networkid", - "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listF5LoadBalancerNetworks,listNetscalerLoadBalancerNetworks,listBrocadeVcsDeviceNetworks", + "name": "isoid", "required": false, "type": "uuid" }, { - "description": "the availability zone ID", + "description": "list by the service offering", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "serviceofferingid", + "related": "updateServiceOffering,listServiceOfferings", "required": false, + "since": "4.4", "type": "uuid" }, { - "description": "List by keyword", + "description": "the target hypervisor for the template", "length": 255, - "name": "keyword", + "name": "hypervisor", "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 cluster ID", "length": 255, - "name": "isrecursive", + "name": "clusterid", + "related": "addCluster,updateCluster", "required": false, - "type": "boolean" + "since": "4.16.0", + "type": "uuid" }, { - "description": "state of the virtual machine. Possible values are: Running, Stopped, Present, Destroyed, Expunged. Present is used for the state equal not destroyed.", + "description": "list vms by ssh keypair name", "length": 255, - "name": "state", + "name": "keypair", "required": false, "type": "string" }, { - "description": "list vms by template", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "templateid", - "related": "listIsos,registerIso,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", + "name": "projectid", + "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", "required": false, "type": "uuid" }, { - "description": "list vms by iso", + "description": "the security group ID", "length": 255, - "name": "isoid", + "name": "securitygroupid", + "related": "createSecurityGroup", "required": false, + "since": "4.15", "type": "uuid" }, { - "description": "the target hypervisor for the template", + "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": "hypervisor", + "name": "name", "required": false, "type": "string" }, { - "description": "the cluster ID", + "description": "list by network id", "length": 255, - "name": "clusterid", - "related": "addCluster,updateCluster", + "name": "networkid", + "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listBrocadeVcsDeviceNetworks", "required": false, - "since": "4.16.0", "type": "uuid" }, + { + "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "length": 255, + "name": "displayvm", + "required": false, + "since": "4.4", + "type": "boolean" + }, { "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, @@ -64337,18 +65912,18 @@ "type": "string" }, { - "description": "comma separated list of host details requested, value can be a list of [all, group, nics, stats, secgrp, tmpl, servoff, diskoff, iso, volume, min, affgrp]. If no parameter is passed in, the details will be defaulted to all", + "description": "List by keyword", "length": 255, - "name": "details", + "name": "keyword", "required": false, - "type": "list" + "type": "string" }, { - "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": "list vms by affinity group", @@ -64359,45 +65934,89 @@ "type": "uuid" }, { - "description": "the host ID", + "description": "Accumulates the VM metrics data instead of returning only the most recent data collected. The default behavior is set by the global configuration vm.stats.increment.metrics.", "length": 255, - "name": "hostid", - "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,reconnectHost,addBaremetalHost", + "name": "accumulate", "required": false, - "type": "uuid" + "since": "4.17.0", + "type": "boolean" }, { - "description": "the pod ID", + "description": "List resources by tags (key/value pairs)", "length": 255, - "name": "podid", - "related": "updatePod,createManagementNetworkIpRange", + "name": "tags", + "required": false, + "type": "map" + }, + { + "description": "flag to display the resource icon for VMs", + "length": 255, + "name": "showicon", + "required": false, + "since": "4.16.0.0", + "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 storage ID where vm's volumes belong to", + "length": 255, + "name": "storageid", + "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool", "required": false, "type": "uuid" }, { - "description": "list by the service offering", + "description": "the IDs of the virtual machines, mutually exclusive with id", "length": 255, - "name": "serviceofferingid", - "related": "updateServiceOffering,listServiceOfferings", + "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 group ID", + "length": 255, + "name": "groupid", + "related": "createInstanceGroup", + "required": false, "type": "uuid" }, { - "description": "the host ID", + "description": "the ID of the virtual machine", "length": 255, - "name": "hostid", - "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,reconnectHost,addBaremetalHost", + "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", "required": false, "type": "uuid" }, { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "description": "list vms by vpc", "length": 255, - "name": "displayvm", + "name": "vpcid", + "related": "listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", + "required": false, + "type": "uuid" + }, + { + "description": "list by network type; true if need to list vms using Virtual Network, false otherwise", + "length": 255, + "name": "forvirtualnetwork", + "required": false, + "type": "boolean" + }, + { + "description": "comma separated list of host details requested, value can be a list of [all, group, nics, stats, secgrp, tmpl, servoff, diskoff, iso, volume, min, affgrp]. If no parameter is passed in, the details will be defaulted to all", + "length": 255, + "name": "details", "required": false, - "since": "4.4", - "type": "boolean" + "type": "list" }, { "description": "the pod ID", @@ -64408,106 +66027,49 @@ "type": "uuid" }, { - "description": "the ID of the virtual machine", + "description": "the host ID", "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": "hostid", + "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,reconnectHost", "required": false, "type": "uuid" }, { - "description": "the storage ID where vm's volumes belong to", + "description": "list vms by template", "length": 255, - "name": "storageid", - "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool", + "name": "templateid", + "related": "listIsos,registerIso,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", "required": false, "type": "uuid" }, { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" - }, - { - "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": "If set to false, list only 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" } ], "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 ID of the virtual machine", - "name": "id", - "type": "string" - }, - { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" - }, - { - "description": "the password (if exists) of the virtual machine", - "name": "password", - "type": "string" - }, - { - "description": "the read (io) of disk on the vm", - "name": "diskioread", - "type": "long" - }, - { - "description": "the ID of the host for the virtual machine", - "name": "hostid", - "type": "string" - }, - {}, - { - "description": "the write (io) of disk on the vm", - "name": "diskiowrite", - "type": "long" - }, - { - "description": "the target memory in vm", - "name": "memorytargetkbs", - "type": "long" - }, - { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", - "type": "string" - }, - { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { - "description": "the vgpu type used by the virtual machine", - "name": "vgpu", + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", - "type": "string" + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" }, { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, { @@ -64516,209 +66078,88 @@ "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", - "type": "string" - }, - { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" - }, - { - "description": "the ID of the affinity group", - "name": "id", - "type": "string" - }, - { - "description": "the account owning the affinity group", - "name": "account", - "type": "string" - }, - { - "description": "the domain ID of the affinity group", - "name": "domainid", - "type": "string" - }, - { - "description": "the description of the affinity group", - "name": "description", - "type": "string" - }, - { - "description": "the domain name of the affinity group", - "name": "domain", - "type": "string" - }, - { - "description": "the 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 name of the template for the virtual machine", - "name": "templatename", - "type": "string" - }, - { - "description": "the ID of the availablility zone for the virtual machine", - "name": "zoneid", - "type": "string" - }, - { - "description": "the user's name who deployed the virtual machine", - "name": "username", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "the ID of the disk offering of the virtual machine", - "name": "diskofferingid", + "description": "the group name of the virtual machine", + "name": "group", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", "type": "string" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", + "description": "ssh key-pairs", + "name": "keypairs", "type": "string" }, { - "description": "the speed of each cpu", - "name": "cpuspeed", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": "the write (bytes) of disk on the vm", - "name": "diskkbswrite", - "type": "long" - }, - { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the name of the disk offering of the virtual machine", + "name": "diskofferingname", "type": "string" }, { - "description": "State of the Service from LB rule", - "name": "servicestate", + "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", + "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 current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the project name of the vm", - "name": "project", - "type": "string" - }, { "description": "device type of the root volume", "name": "rootdevicetype", "type": "string" }, { - "description": "the group name of the virtual machine", - "name": "group", - "type": "string" - }, - { - "description": "the incoming network traffic on the vm", - "name": "networkkbsread", + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", "type": "long" }, { - "description": "Guest vm Boot Type", - "name": "boottype", - "type": "string" - }, - { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", - "type": "string" - }, - { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "the name of the disk offering of the virtual machine", - "name": "diskofferingname", - "type": "string" - }, - { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", "type": "string" }, { - "description": "the pool type of the virtual machine", - "name": "pooltype", - "type": "string" + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" }, { - "description": "OS name of the vm", - "name": "osdisplayname", + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", "type": "string" }, - { - "description": "the read (bytes) of disk on the vm", - "name": "diskkbsread", - "type": "long" - }, - { - "description": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" - }, { "description": "the list of resource tags associated", "name": "tags", "response": [ { - "description": "the account associated with the tag", - "name": "account", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { @@ -64727,18 +66168,18 @@ "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { @@ -64747,117 +66188,71 @@ "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" } ], "type": "set" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", - "type": "string" - }, - { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" - }, - { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", "type": "boolean" }, { - "description": "the account associated with the virtual machine", - "name": "account", - "type": "string" - }, - {}, - { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", - "type": "string" + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" }, { - "description": "the state of the virtual machine", - "name": "state", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", + "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": "OS type id of the vm", - "name": "ostypeid", + "description": "Guest vm Boot Type", + "name": "boottype", "type": "string" }, { - "description": "the name of the host for the virtual machine", - "name": "hostname", + "description": "the user's ID who deployed the virtual machine", + "name": "userid", "type": "string" }, { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" - }, - { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", + "description": "OS name of the vm", + "name": "osdisplayname", "type": "string" }, { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", + "description": "the pool type of the virtual machine", + "name": "pooltype", "type": "string" }, { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" - }, - { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" - }, - { - "description": "Os type ID of the virtual machine", - "name": "guestosid", + "description": "State of the Service from LB rule", + "name": "servicestate", "type": "string" }, { - "description": "the outgoing network traffic on the host", - "name": "networkkbswrite", - "type": "long" - }, - { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", + "description": "OS type id of the vm", + "name": "ostypeid", "type": "string" }, { - "description": "the group ID of the virtual machine", - "name": "groupid", + "description": "the project id of the vm", + "name": "projectid", "type": "string" }, { @@ -64865,29 +66260,34 @@ "name": "nic", "response": [ { - "description": "the ID of the nic", - "name": "id", + "description": "the type of the nic", + "name": "type", "type": "string" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" + "description": "the ip address of the nic", + "name": "ipaddress", + "type": "string" }, { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "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", @@ -64895,108 +66295,276 @@ "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" + }, + { + "description": "the isolation uri of the nic", + "name": "isolationuri", "type": "string" }, { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "true if nic is default, false otherwise", + "name": "macaddress", "type": "string" }, { - "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": "the ip address of the nic", - "name": "ipaddress", + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", + "type": "string" + }, + { + "description": "Id of the 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": "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 gateway of the nic", + "name": "gateway", "type": "string" }, + { + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, { "description": "the isolated private VLAN if available", "name": "isolatedpvlan", "type": "integer" }, { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "type": "string" }, { - "description": "the gateway of the nic", - "name": "gateway", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + }, + { + "description": "the name of the corresponding network", + "name": "networkname", "type": "string" }, { - "description": "the type of the nic", - "name": "type", + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the project name of the vm", + "name": "project", + "type": "string" + }, + {}, + { + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" + }, + { + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" + }, + { + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" + }, + { + "description": "the user's name who deployed the virtual machine", + "name": "username", + "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": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" - }, - { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", + "description": "the ID of the affinity group", + "name": "id", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "the account owning the affinity group", + "name": "account", "type": "string" }, { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "the description of the affinity group", + "name": "description", "type": "string" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "the domain name of the affinity group", + "name": "domain", "type": "string" }, { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "the project name of the affinity group", + "name": "project", "type": "string" }, { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - }, - { - "description": "the traffic type of the nic", - "name": "traffictype", - "type": "string" + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" }, { - "description": "the netmask of the nic", - "name": "netmask", + "description": "the domain ID of the affinity group", + "name": "domainid", "type": "string" }, { - "description": "the IPv6 address of network", - "name": "ip6address", + "description": "the project ID of the affinity group", + "name": "projectid", "type": "string" }, { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "the type of the affinity group", + "name": "type", "type": "string" - }, - { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" } ], "type": "set" }, + { + "description": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" + }, + { + "description": "the ID of the availablility zone for the virtual machine", + "name": "zoneid", + "type": "string" + }, + { + "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", + "type": "long" + }, + { + "description": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" + }, + { + "description": "the name of the virtual machine", + "name": "name", + "type": "string" + }, + { + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", + "type": "string" + }, + { + "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", + "type": "string" + }, + { + "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": "the ID of the domain in which the virtual machine exists", + "name": "domainid", + "type": "string" + }, + { + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", + "type": "string" + }, + { + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "the memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" + }, + { + "description": "the read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" + }, + { + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" + }, { "description": "list of security groups associated with the virtual machine", "name": "securitygroup", @@ -65005,43 +66573,48 @@ "description": "the list of egress rules associated with the security group", "name": "egressrule", "response": [ + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, { "description": "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", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "tag key name", + "name": "key", "type": "string" }, { @@ -65050,93 +66623,78 @@ "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", "type": "string" } ], "type": "set" }, - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, { "description": "the code for the ICMP message response", "name": "icmpcode", "type": "integer" }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, { "description": "the id of the security group rule", "name": "ruleid", "type": "string" }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, { "description": "security group name", "name": "securitygroupname", "type": "string" }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, { "description": "account owning the security group rule", "name": "account", "type": "string" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" } ], "type": "set" }, - { - "description": "the ID of the security group", - "name": "id", - "type": "string" - }, - { - "description": "the account owning the security group", - "name": "account", - "type": "string" - }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { @@ -65145,170 +66703,170 @@ "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "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": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" } ], "type": "set" }, + { + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" + }, + { + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" + }, { "description": "the list of ingress rules associated with the security group", "name": "ingressrule", "response": [ - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, { "description": "account owning the security group rule", "name": "account", "type": "string" }, - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "tag value", - "name": "value", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the 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 ID of the domain associated with the tag", - "name": "domainid", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "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": "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": "resource type", + "name": "resourcetype", "type": "string" } ], "type": "set" }, + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, { "description": "the ending IP of the security group rule ", "name": "endport", "type": "integer" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "the 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", + "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 domain ID of the security group", "name": "domainid", "type": "string" }, { - "description": "the project name of the group", - "name": "project", - "type": "string" - }, - { - "description": "the name of the security group", - "name": "name", + "description": "the account owning the security group", + "name": "account", "type": "string" }, { @@ -65322,72 +66880,122 @@ "type": "string" }, { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" + "description": "the ID of the security group", + "name": "id", + "type": "string" + }, + { + "description": "the project id of the group", + "name": "projectid", + "type": "string" + }, + { + "description": "the project name of the group", + "name": "project", + "type": "string" } ], "type": "set" }, { - "description": "the memory used by the vm", - "name": "memorykbs", - "type": "long" + "description": "Os type ID of the virtual machine", + "name": "guestosid", + "type": "string" }, { - "description": "the internal memory that's free in vm or zero if it can not be calculated", - "name": "memoryintfreekbs", + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" + }, + { + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" + }, + { + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", "type": "long" }, - {}, { - "description": "ssh key-pair", - "name": "keypair", + "description": "the ID of the disk offering of the virtual machine", + "name": "diskofferingid", "type": "string" }, { - "description": "the number of cpu this virtual machine is running with", - "name": "cpunumber", - "type": "integer" + "description": "the account associated with the virtual machine", + "name": "account", + "type": "string" }, { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", + "description": "the 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": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", + "type": "boolean" + }, + { + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", "type": "string" }, { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" + }, + { + "description": "Guest vm Boot Mode", + "name": "bootmode", + "type": "string" + }, + { + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", + "type": "string" + }, + { + "description": "the ID of the virtual machine", + "name": "id", + "type": "string" + }, + { + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" + }, + { + "description": "the name of the host for the virtual machine", + "name": "hostname", "type": "string" }, { - "description": "the project id of the vm", - "name": "projectid", + "description": "the state of the virtual machine", + "name": "state", "type": "string" }, { - "description": "the name of the virtual machine", - "name": "name", - "type": "string" + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" }, { "description": "the ID of the service offering of the virtual machine", "name": "serviceofferingid", "type": "string" }, + {}, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", - "type": "string" + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" }, { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", + "description": "the password (if exists) of the virtual machine", + "name": "password", "type": "string" }, { @@ -65396,9 +67004,14 @@ "type": "map" }, { - "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": "the name of the domain in which the virtual machine exists", + "name": "domain", + "type": "string" } ] }, @@ -65408,32 +67021,37 @@ "name": "updateGuestOsMapping", "params": [ { - "description": "UUID of the Guest OS to hypervisor name Mapping", + "description": "Hypervisor specific name for this Guest OS", "length": 255, - "name": "id", - "related": "updateGuestOsMapping", + "name": "osnameforhypervisor", "required": true, - "type": "uuid" + "type": "string" }, { - "description": "Hypervisor specific name for this Guest OS", + "description": "UUID of the Guest OS to hypervisor name Mapping", "length": 255, - "name": "osnameforhypervisor", + "name": "id", + "related": "updateGuestOsMapping", "required": true, - "type": "string" + "type": "uuid" } ], "related": "", "response": [ + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "version of the hypervisor for mapping", "name": "hypervisorversion", "type": "string" }, - {}, { - "description": "the ID of the Guest OS type", - "name": "ostypeid", + "description": "hypervisor specific name for the Guest OS", + "name": "osnameforhypervisor", "type": "string" }, { @@ -65441,35 +67059,30 @@ "name": "isuserdefined", "type": "string" }, + {}, { - "description": "the hypervisor", - "name": "hypervisor", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "standard display name for the Guest OS", + "name": "osdisplayname", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the ID of the Guest OS type", + "name": "ostypeid", "type": "string" }, - {}, { "description": "the ID of the Guest OS mapping", "name": "id", "type": "string" }, { - "description": "standard display name for the Guest OS", - "name": "osdisplayname", - "type": "string" - }, - { - "description": "hypervisor specific name for the Guest OS", - "name": "osnameforhypervisor", + "description": "the hypervisor", + "name": "hypervisor", "type": "string" } ], @@ -65481,17 +67094,16 @@ "name": "listDiskOfferings", "params": [ { - "description": "list only resources belonging to the domain specified", + "description": "name of the disk offering", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", + "name": "name", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "If set to false, list only 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": "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" }, @@ -65504,61 +67116,75 @@ "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": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, { - "description": "name of the disk offering", + "description": "The ID of the volume, tags of the volume are used to filter the offerings", "length": 255, - "name": "name", + "name": "volumeid", + "related": "attachVolume,createVolume,listVolumes,migrateVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", "required": false, - "type": "string" + "since": "4.17", + "type": "uuid" + }, + { + "description": "id of zone disk offering is associated with", + "length": 255, + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": false, + "since": "4.13", + "type": "uuid" }, { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, { - "description": "List by keyword", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "keyword", + "name": "listall", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "id of zone disk offering is associated with", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "domainid", + "related": "listDomainChildren,listDomains", "required": false, - "since": "4.13", + "type": "uuid" + }, + { + "description": "The ID of the storage pool, tags of the storage pool are used to filter the offerings", + "length": 255, + "name": "storageid", + "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool", + "required": false, + "since": "4.17", "type": "uuid" } ], "related": "createDiskOffering", "response": [ { - "description": "an alternate display text of the disk offering.", - "name": "displaytext", - "type": "string" - }, - { - "description": "the vsphere storage policy tagged to the disk offering in case of VMware", - "name": "vspherestoragepolicy", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "the min iops of the disk offering", @@ -65566,74 +67192,93 @@ "type": "long" }, { - "description": "the max iops of the disk offering", - "name": "maxiops", - "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 if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "length (in seconds) of the burst", + "name": "diskBytesWriteRateMaxLength", + "type": "long" }, { - "description": "burst bytes read rate of the disk offering", - "name": "diskBytesReadRateMax", + "description": "the size of the disk offering in GB", + "name": "disksize", "type": "long" }, { - "description": "the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zone", - "type": "string" + "description": "true if disk offering uses custom size, false otherwise", + "name": "iscustomized", + "type": "boolean" }, { - "description": "whether to display the offering to the end user or not.", - "name": "displayoffering", - "type": "boolean" + "description": "the max iops of the disk offering", + "name": "maxiops", + "type": "long" }, { - "description": "the tags for the disk offering", - "name": "tags", + "description": "unique ID of the disk offering", + "name": "id", "type": "string" }, { - "description": "provisioning type used to create volumes. Valid values are thin, sparse, fat.", - "name": "provisioningtype", + "description": "the vsphere storage policy tagged to the disk offering in case of VMware", + "name": "vspherestoragepolicy", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "bytes read rate of the disk offering", + "name": "diskBytesReadRate", + "type": "long" }, { - "description": "the cache mode to use for this disk offering. none, writeback or writethrough", - "name": "cacheMode", + "description": "the storage type for this disk offering", + "name": "storagetype", "type": "string" }, { - "description": "the size of the disk offering in GB", - "name": "disksize", + "description": "io requests read rate of the disk offering", + "name": "diskIopsReadRate", "type": "long" }, { - "description": "true if disk offering uses custom iops, false otherwise", - "name": "iscustomizediops", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "burst io requests write rate of the disk offering", - "name": "diskIopsWriteRateMax", + "description": "Hypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware)", + "name": "hypervisorsnapshotreserve", + "type": "integer" + }, + { + "description": "burst bytes write rate of the disk offering", + "name": "diskBytesWriteRateMax", "type": "long" }, { - "description": "length (in seconds) of the burst", - "name": "diskIopsWriteRateMaxLength", + "description": "provisioning type used to create volumes. Valid values are thin, sparse, fat.", + "name": "provisioningtype", + "type": "string" + }, + { + "description": "the tags for the disk offering", + "name": "tags", + "type": "string" + }, + { + "description": "the name of the disk offering", + "name": "name", + "type": "string" + }, + { + "description": "burst io requests read rate of the disk offering", + "name": "diskIopsReadRateMax", "type": "long" }, - {}, { - "description": "bytes read rate of the disk offering", - "name": "diskBytesReadRate", + "description": "bytes write rate of the disk offering", + "name": "diskBytesWriteRate", "type": "long" }, { @@ -65642,90 +67287,81 @@ "type": "long" }, { - "description": "bytes write rate of the disk offering", - "name": "diskBytesWriteRate", + "description": "length (in seconds) of the burst", + "name": "diskIopsWriteRateMaxLength", "type": "long" }, { - "description": "the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "domainid", + "description": "the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "domain", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "length (in second) of the burst", + "name": "diskIopsReadRateMaxLength", + "type": "long" }, { - "description": "length (in seconds) of the burst", - "name": "diskBytesWriteRateMaxLength", + "description": "io requests write rate of the disk offering", + "name": "diskIopsWriteRate", "type": "long" }, { - "description": "io requests read rate of the disk offering", - "name": "diskIopsReadRate", - "type": "long" + "description": "true if disk offering uses custom iops, false otherwise", + "name": "iscustomizediops", + "type": "boolean" }, { - "description": "the date this disk offering was created", - "name": "created", - "type": "date" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zoneid", + "description": "the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "domainid", "type": "string" }, {}, { - "description": "the 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 write rate of the disk offering", + "name": "diskIopsWriteRateMax", + "type": "long" }, { - "description": "the name of the disk offering", - "name": "name", - "type": "string" + "description": "burst bytes read rate of the disk offering", + "name": "diskBytesReadRateMax", + "type": "long" }, { - "description": "unique ID of the disk offering", - "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" }, { - "description": "true if disk offering uses custom size, false otherwise", - "name": "iscustomized", + "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": "burst io requests read rate of the disk offering", - "name": "diskIopsReadRateMax", - "type": "long" + "description": "the date this disk offering was created", + "name": "created", + "type": "date" }, { - "description": "the storage type for this disk offering", - "name": "storagetype", + "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", - "type": "long" - }, - { - "description": "io requests write rate of the disk offering", - "name": "diskIopsWriteRate", - "type": "long" - }, - { - "description": "length (in second) of the burst", - "name": "diskIopsReadRateMaxLength", - "type": "long" + "description": "an alternate display text of the disk offering.", + "name": "displaytext", + "type": "string" }, + {}, { - "description": "Hypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware)", - "name": "hypervisorsnapshotreserve", - "type": "integer" + "description": "whether to display the offering to the end user or not.", + "name": "displayoffering", + "type": "boolean" } ] }, @@ -65734,11 +67370,26 @@ "isasync": false, "name": "updateHostPassword", "params": [ + { + "description": "the username for the host/cluster", + "length": 255, + "name": "username", + "required": true, + "type": "string" + }, + { + "description": "the cluster ID", + "length": 255, + "name": "clusterid", + "related": "addCluster,updateCluster", + "required": false, + "type": "uuid" + }, { "description": "the host ID", "length": 255, "name": "hostid", - "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,reconnectHost,addBaremetalHost", + "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,reconnectHost", "required": false, "type": "uuid" }, @@ -65755,46 +67406,31 @@ "name": "update_passwd_on_host", "required": false, "type": "boolean" - }, - { - "description": "the username for the host/cluster", - "length": 255, - "name": "username", - "required": true, - "type": "string" - }, - { - "description": "the cluster ID", - "length": 255, - "name": "clusterid", - "related": "addCluster,updateCluster", - "required": false, - "type": "uuid" } ], "response": [ - {}, - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - }, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, + {}, { "description": "the 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" - }, - {} + } ] }, { @@ -65803,9 +67439,9 @@ "name": "createPortableIpRange", "params": [ { - "description": "the netmask of the portable IP range", + "description": "the gateway for the portable IP range", "length": 255, - "name": "netmask", + "name": "gateway", "required": true, "type": "string" }, @@ -65818,9 +67454,9 @@ "type": "integer" }, { - "description": "the ending IP address in the portable IP range", + "description": "the beginning IP address in the portable IP range", "length": 255, - "name": "endip", + "name": "startip", "required": true, "type": "string" }, @@ -65832,37 +67468,46 @@ "type": "string" }, { - "description": "the gateway for the portable IP range", + "description": "the ending IP address in the portable IP range", "length": 255, - "name": "gateway", + "name": "endip", "required": true, "type": "string" }, { - "description": "the beginning IP address in the portable IP range", + "description": "the netmask of the portable IP range", "length": 255, - "name": "startip", + "name": "netmask", "required": true, "type": "string" } ], "related": "", "response": [ - {}, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the start ip of the portable IP range", + "name": "startip", "type": "string" }, { - "description": "the netmask of the VLAN IP range", - "name": "netmask", + "description": "the ID or VID of the VLAN.", + "name": "vlan", "type": "string" }, + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { - "description": "the start ip of the portable IP range", - "name": "startip", + "description": "the gateway of the VLAN IP range", + "name": "gateway", + "type": "string" + }, + { + "description": "portable IP range ID", + "name": "id", "type": "string" }, { @@ -65870,33 +67515,39 @@ "name": "regionid", "type": "integer" }, + { + "description": "the netmask of the VLAN IP range", + "name": "netmask", + "type": "string" + }, + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, { "description": "List of portable IP and association with zone/network/vpc details that are part of GSLB rule", "name": "portableipaddress", "response": [ { - "description": "public IP address", - "name": "ipaddress", + "description": "VPC the ip belongs to", + "name": "vpcid", "type": "string" }, { - "description": "date the portal IP address was acquired", - "name": "allocated", - "type": "date" - }, - { - "description": "VPC the ip belongs to", - "name": "vpcid", + "description": "the account ID the portable IP address is associated with", + "name": "accountid", "type": "string" }, { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", + "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", + "description": "the domain ID the portable IP address is associated with", + "name": "domainid", "type": "string" }, { @@ -65905,48 +67556,33 @@ "type": "string" }, { - "description": "Region Id in which global load balancer is created", - "name": "regionid", - "type": "integer" + "description": "date the portal IP address was acquired", + "name": "allocated", + "type": "date" }, { - "description": "the account ID the portable IP address is associated with", - "name": "accountid", + "description": "the physical network this belongs to", + "name": "physicalnetworkid", "type": "string" }, { - "description": "the ID of the Network where ip belongs to", - "name": "networkid", + "description": "the ID of the zone the public IP address belongs to", + "name": "zoneid", "type": "string" }, { - "description": "the domain ID the portable IP address is associated with", - "name": "domainid", + "description": "Region Id in which global load balancer is created", + "name": "regionid", + "type": "integer" + }, + { + "description": "public IP address", + "name": "ipaddress", "type": "string" } ], "type": "list" }, - { - "description": "the ID or VID of the VLAN.", - "name": "vlan", - "type": "string" - }, - { - "description": "portable IP range ID", - "name": "id", - "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 end ip of the portable IP range", "name": "endip", @@ -65960,6 +67596,20 @@ "isasync": false, "name": "updateCluster", "params": [ + { + "description": "whether this cluster is managed by cloudstack", + "length": 255, + "name": "managedstate", + "required": false, + "type": "string" + }, + { + "description": "hypervisor type of the cluster", + "length": 255, + "name": "hypervisor", + "required": false, + "type": "string" + }, { "description": "hypervisor type of the cluster", "length": 255, @@ -65967,6 +67617,13 @@ "required": false, "type": "string" }, + { + "description": "the cluster name", + "length": 255, + "name": "clustername", + "required": false, + "type": "string" + }, { "description": "the ID of the Cluster", "length": 255, @@ -65976,58 +67633,67 @@ "type": "uuid" }, { - "description": "whether this cluster is managed by cloudstack", - "length": 255, - "name": "managedstate", - "required": false, + "description": "Allocation state of this cluster for allocation of new resources", + "length": 255, + "name": "allocationstate", + "required": false, + "type": "string" + } + ], + "related": "addCluster", + "response": [ + { + "description": "the Zone name of the cluster", + "name": "zonename", + "type": "string" + }, + { + "description": "the Zone ID of the cluster", + "name": "zoneid", "type": "string" }, { - "description": "hypervisor type of the cluster", - "length": 255, - "name": "hypervisor", - "required": false, + "description": "the type of the cluster", + "name": "clustertype", "type": "string" }, { - "description": "the cluster name", - "length": 255, - "name": "clustername", - "required": false, + "description": "The cpu overcommit ratio of the cluster", + "name": "cpuovercommitratio", "type": "string" }, { - "description": "Allocation state of this cluster for allocation of new resources", - "length": 255, + "description": "the allocation state of the cluster", "name": "allocationstate", - "required": false, "type": "string" - } - ], - "related": "addCluster", - "response": [ + }, { "description": "the capacity of the Cluster", "name": "capacity", "response": [ { - "description": "the Pod name", - "name": "podname", + "description": "the Zone ID", + "name": "zoneid", "type": "string" }, { - "description": "the Pod ID", - "name": "podid", + "description": "the capacity name", + "name": "name", "type": "string" }, { - "description": "the capacity type", - "name": "type", - "type": "short" + "description": "the capacity currently in allocated", + "name": "capacityallocated", + "type": "long" }, { - "description": "the percentage of capacity currently in use", - "name": "percentused", + "description": "the Cluster name", + "name": "clustername", + "type": "string" + }, + { + "description": "the Pod name", + "name": "podname", "type": "string" }, { @@ -66036,24 +67702,24 @@ "type": "long" }, { - "description": "the capacity name", - "name": "name", + "description": "the percentage of capacity currently in use", + "name": "percentused", "type": "string" }, { - "description": "the Zone name", - "name": "zonename", + "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 Zone ID", - "name": "zoneid", - "type": "string" + "description": "the capacity type", + "name": "type", + "type": "short" }, { "description": "the total capacity available", @@ -66061,68 +67727,43 @@ "type": "long" }, { - "description": "the Cluster ID", - "name": "clusterid", - "type": "string" - }, - { - "description": "the Cluster name", - "name": "clustername", + "description": "the Zone name", + "name": "zonename", "type": "string" } ], "type": "list" }, { - "description": "the Pod ID of the cluster", - "name": "podid", - "type": "string" - }, - { - "description": "Meta data associated with the zone (key/value pairs)", - "name": "resourcedetails", - "type": "map" - }, - {}, - { - "description": "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 memory overcommit ratio of the cluster", + "name": "memoryovercommitratio", "type": "string" }, { - "description": "the cluster ID", - "name": "id", + "description": "the hypervisor type of the cluster", + "name": "hypervisortype", "type": "string" }, {}, { - "description": "the cluster name", - "name": "name", - "type": "string" - }, - { - "description": "the Zone name of the cluster", - "name": "zonename", + "description": "Ovm3 VIP to use for pooling and/or clustering", + "name": "ovm3vip", "type": "string" }, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "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": "whether this cluster is managed by cloudstack", - "name": "managedstate", + "description": "the Pod name of the cluster", + "name": "podname", "type": "string" }, { @@ -66131,33 +67772,28 @@ "type": "boolean" }, { - "description": "The memory overcommit ratio of the cluster", - "name": "memoryovercommitratio", - "type": "string" - }, - { - "description": "the allocation state of the cluster", - "name": "allocationstate", - "type": "string" + "description": "Meta data associated with the zone (key/value pairs)", + "name": "resourcedetails", + "type": "map" }, { - "description": "the hypervisor type of the cluster", - "name": "hypervisortype", + "description": "the cluster ID", + "name": "id", "type": "string" }, { - "description": "the Zone ID of the cluster", - "name": "zoneid", + "description": "the cluster name", + "name": "name", "type": "string" }, { - "description": "The cpu overcommit ratio of the cluster", - "name": "cpuovercommitratio", + "description": "the Pod ID of the cluster", + "name": "podid", "type": "string" }, { - "description": "the Pod name of the cluster", - "name": "podname", + "description": "whether this cluster is managed by cloudstack", + "name": "managedstate", "type": "string" } ] @@ -66177,26 +67813,26 @@ } ], "response": [ - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - {}, - {}, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, + {}, + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "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" } ] @@ -66226,13 +67862,23 @@ "related": "createKubernetesCluster,startKubernetesCluster", "response": [ { - "description": "the size (worker nodes count) of the Kubernetes cluster", - "name": "size", + "description": "Maximum size of the cluster", + "name": "maxsize", "type": "long" }, { - "description": "the ID of the network of the Kubernetes cluster", - "name": "networkid", + "description": "the name of the network of the Kubernetes cluster", + "name": "associatednetworkname", + "type": "string" + }, + { + "description": "the date when this Kubernetes cluster was created", + "name": "created", + "type": "date" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -66241,98 +67887,95 @@ "type": "list" }, { - "description": "the name of the zone of the Kubernetes cluster", - "name": "zonename", + "description": "the name of the service offering of the Kubernetes cluster", + "name": "serviceofferingname", "type": "string" }, { - "description": "the master nodes count for the Kubernetes cluster. This parameter is deprecated, please use 'controlnodes' parameter.", - "name": "masternodes", - "type": "long" + "description": "the name of the Kubernetes cluster", + "name": "name", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the ID of the domain in which the Kubernetes cluster exists", + "name": "domainid", "type": "string" }, { - "description": "the ID of the template of the Kubernetes cluster", - "name": "templateid", + "description": "URL end point for the Kubernetes cluster", + "name": "endpoint", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the ID of the Kubernetes version for the Kubernetes cluster", + "name": "kubernetesversionid", + "type": "string" }, { - "description": "Whether autoscaling is enabled for the cluster", - "name": "autoscalingenabled", + "description": "the control nodes count for the Kubernetes cluster", + "name": "controlnodes", + "type": "long" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "Public IP Address ID of the cluster", - "name": "ipaddressid", + "description": "the id of the Kubernetes cluster", + "name": "id", "type": "string" }, { - "description": "the name of the zone of the Kubernetes cluster", - "name": "zoneid", + "description": "the ID of the service offering of the Kubernetes cluster", + "name": "serviceofferingid", "type": "string" }, { - "description": "keypair details", - "name": "keypair", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, { "description": "URL end point for the Kubernetes cluster dashboard UI", "name": "consoleendpoint", "type": "string" }, { - "description": "URL end point for the Kubernetes cluster", - "name": "endpoint", - "type": "string" - }, - { - "description": "the ID of the domain in which the Kubernetes cluster exists", - "name": "domainid", - "type": "string" - }, - { - "description": "the id of the Kubernetes cluster", - "name": "id", + "description": "the ID of the network of the Kubernetes cluster", + "name": "networkid", "type": "string" }, { - "description": "the state of the Kubernetes cluster", - "name": "state", + "description": "the description of the Kubernetes cluster", + "name": "description", "type": "string" }, { - "description": "the name of the Kubernetes version for the Kubernetes cluster", - "name": "kubernetesversionname", + "description": "the project id of the Kubernetes cluster", + "name": "projectid", "type": "string" }, { - "description": "the name of the network of the Kubernetes cluster", - "name": "associatednetworkname", + "description": "Public IP Address of the cluster", + "name": "ipaddress", "type": "string" }, + {}, { - "description": "Maximum size of the cluster", - "name": "maxsize", + "description": "Minimum size of the cluster", + "name": "minsize", "type": "long" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the name of the Kubernetes version for the Kubernetes cluster", + "name": "kubernetesversionname", + "type": "string" }, { - "description": "Public IP Address of the cluster", - "name": "ipaddress", + "description": "the state of the Kubernetes cluster", + "name": "state", "type": "string" }, { @@ -66341,73 +67984,71 @@ "type": "string" }, { - "description": "the description of the Kubernetes cluster", - "name": "description", + "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": "the name of the domain in which the Kubernetes cluster exists", - "name": "domain", + "description": "keypair details", + "name": "keypair", "type": "string" }, { - "description": "the ID of the Kubernetes version for the Kubernetes cluster", - "name": "kubernetesversionid", + "description": "the name of the zone of the Kubernetes cluster", + "name": "zoneid", "type": "string" }, { - "description": "Minimum size of the cluster", - "name": "minsize", + "description": "the master nodes count for the Kubernetes cluster. This parameter is deprecated, please use 'controlnodes' parameter.", + "name": "masternodes", "type": "long" }, - {}, - {}, { - "description": "the name of the service offering of the Kubernetes cluster", - "name": "serviceofferingname", + "description": "the account associated with the Kubernetes cluster", + "name": "account", "type": "string" }, { - "description": "the project id of the Kubernetes cluster", - "name": "projectid", - "type": "string" + "description": "Whether autoscaling is enabled for the cluster", + "name": "autoscalingenabled", + "type": "boolean" }, { - "description": "the name of the Kubernetes cluster", - "name": "name", + "description": "the size (worker nodes count) of the Kubernetes cluster", + "name": "size", + "type": "long" + }, + { + "description": "the memory the Kubernetes cluster", + "name": "memory", "type": "string" }, { - "description": "the ID of the service offering of the Kubernetes cluster", - "name": "serviceofferingid", + "description": "the project name of the Kubernetes cluster", + "name": "project", "type": "string" }, { - "description": "the memory the Kubernetes cluster", - "name": "memory", + "description": "Public IP Address ID of the cluster", + "name": "ipaddressid", "type": "string" }, { - "description": "the account associated with the Kubernetes cluster", - "name": "account", + "description": "the name of the domain in which the Kubernetes cluster exists", + "name": "domain", "type": "string" }, { - "description": "the project name of the Kubernetes cluster", - "name": "project", + "description": "the ID of the template of the Kubernetes cluster", + "name": "templateid", "type": "string" } ] }, { - "description": "List profile in ucs manager", + "description": "Lists storage providers.", "isasync": false, - "name": "listUcsProfiles", + "name": "listStorageProviders", "params": [ { "description": "List by keyword", @@ -66424,12 +68065,11 @@ "type": "integer" }, { - "description": "the id for the ucs manager", + "description": "the type of storage provider: either primary or image", "length": 255, - "name": "ucsmanagerid", - "related": "addUcsManager", + "name": "type", "required": true, - "type": "uuid" + "type": "string" }, { "description": "", @@ -66442,8 +68082,18 @@ "related": "", "response": [ { - "description": "ucs profile dn", - "name": "ucsdn", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the type of the storage provider: primary or image provider", + "name": "type", + "type": "string" + }, + { + "description": "the name of the storage provider", + "name": "name", "type": "string" }, {}, @@ -66452,23 +68102,26 @@ "description": "the UUID of the latest async job acting on 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.", + "description": "List profile in ucs manager", "isasync": false, - "name": "listStorageProviders", + "name": "listUcsProfiles", "params": [ + { + "description": "the id for the ucs manager", + "length": 255, + "name": "ucsmanagerid", + "related": "addUcsManager", + "required": true, + "type": "uuid" + }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, @@ -66479,17 +68132,10 @@ "required": false, "type": "string" }, - { - "description": "the type of storage provider: either primary or image", - "length": 255, - "name": "type", - "required": true, - "type": "string" - }, { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" } @@ -66497,7 +68143,11 @@ "related": "", "response": [ {}, - {}, + { + "description": "ucs profile dn", + "name": "ucsdn", + "type": "string" + }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", @@ -66508,16 +68158,7 @@ "name": "jobstatus", "type": "integer" }, - { - "description": "the name of the storage provider", - "name": "name", - "type": "string" - }, - { - "description": "the type of the storage provider: primary or image provider", - "name": "type", - "type": "string" - } + {} ] }, { @@ -66542,9 +68183,9 @@ "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the api key of the registered user", + "name": "apikey", + "type": "string" }, {}, {}, @@ -66554,9 +68195,9 @@ "type": "string" }, { - "description": "the api key of the registered user", - "name": "apikey", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ], "since": "4.10.0" @@ -66567,11 +68208,12 @@ "name": "updateGlobalLoadBalancerRule", "params": [ { - "description": "the description of the load balancer rule", - "length": 4096, - "name": "description", - "required": false, - "type": "string" + "description": "the ID of the global load balancer rule", + "length": 255, + "name": "id", + "related": "updateGlobalLoadBalancerRule", + "required": true, + "type": "uuid" }, { "description": "session sticky method (sourceip) if not specified defaults to sourceip", @@ -66588,12 +68230,11 @@ "type": "string" }, { - "description": "the ID of the global load balancer rule", - "length": 255, - "name": "id", - "related": "updateGlobalLoadBalancerRule", - "required": true, - "type": "uuid" + "description": "the description of the load balancer rule", + "length": 4096, + "name": "description", + "required": false, + "type": "string" } ], "related": "", @@ -66603,24 +68244,70 @@ "name": "gslbstickysessionmethodname", "type": "string" }, + { + "description": "the project name of the load balancer", + "name": "project", + "type": "string" + }, { "description": "DNS domain name given for the global load balancer", "name": "gslbdomainname", "type": "string" }, { - "description": "the domain of the load balancer rule", - "name": "domain", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the project id of the load balancer", + "name": "projectid", + "type": "string" + }, + { + "description": "the account of the load balancer rule", + "name": "account", "type": "string" }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "GSLB service type", "name": "gslbservicetype", "type": "string" }, + {}, { - "description": "the project id of the load balancer", - "name": "projectid", + "description": "the domain of the load balancer rule", + "name": "domain", + "type": "string" + }, + { + "description": "name of the global load balancer rule", + "name": "name", + "type": "string" + }, + { + "description": "global load balancer rule ID", + "name": "id", + "type": "string" + }, + { + "description": "the domain ID of the load balancer rule", + "name": "domainid", + "type": "string" + }, + { + "description": "the description of the global load balancer rule", + "name": "description", + "type": "string" + }, + { + "description": "Load balancing method used for the global load balancer", + "name": "gslblbmethod", "type": "string" }, { @@ -66628,28 +68315,90 @@ "name": "loadbalancerrule", "response": [ { - "description": "the name of the load balancer", - "name": "name", + "description": "the project name of the load balancer", + "name": "project", "type": "string" }, { - "description": "the domain ID of the load balancer rule", - "name": "domainid", + "description": "is rule for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, + { + "description": "the list of resource tags associated with load balancer", + "name": "tags", + "response": [ + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + } + ], + "type": "list" + }, + { + "description": "the public ip address id", + "name": "publicipid", "type": "string" }, { - "description": "the state of the rule", - "name": "state", + "description": "the public ip address", + "name": "publicip", "type": "string" }, { - "description": "the private port", - "name": "privateport", + "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", "type": "string" }, { - "description": "the load balancer algorithm (source, roundrobin, leastconn)", - "name": "algorithm", + "description": "the account of the load balancer rule", + "name": "account", "type": "string" }, { @@ -66658,18 +68407,18 @@ "type": "string" }, { - "description": "the load balancer rule ID", - "name": "id", + "description": "the name of the zone the load balancer rule belongs to", + "name": "zonename", "type": "string" }, { - "description": "the public ip address", - "name": "publicip", + "description": "the load balancer algorithm (source, roundrobin, leastconn)", + "name": "algorithm", "type": "string" }, { - "description": "the id of the zone the rule belongs to", - "name": "zoneid", + "description": "the domain ID of the load balancer rule", + "name": "domainid", "type": "string" }, { @@ -66678,33 +68427,23 @@ "type": "string" }, { - "description": "the project name of the load balancer", - "name": "project", - "type": "string" - }, - { - "description": "the public port", - "name": "publicport", + "description": "the project id of the load balancer", + "name": "projectid", "type": "string" }, { - "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", + "description": "the private port", + "name": "privateport", "type": "string" }, { - "description": "is rule for display to the regular user", - "name": "fordisplay", - "type": "boolean" - }, - { - "description": "the name of the zone the load balancer rule belongs to", - "name": "zonename", + "description": "the name of the load balancer", + "name": "name", "type": "string" }, { - "description": "the project id of the load balancer", - "name": "projectid", + "description": "the protocol of the loadbalanacer rule", + "name": "protocol", "type": "string" }, { @@ -66713,132 +68452,34 @@ "type": "string" }, { - "description": "the account of the load balancer rule", - "name": "account", + "description": "the load balancer rule ID", + "name": "id", "type": "string" }, { - "description": "the protocol of the loadbalanacer rule", - "name": "protocol", + "description": "the state of the rule", + "name": "state", "type": "string" }, { - "description": "the public ip address id", - "name": "publicipid", + "description": "the id of the zone the rule belongs to", + "name": "zoneid", "type": "string" }, { - "description": "the list of resource tags associated with load balancer", - "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": "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" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - } - ], - "type": "list" + "description": "the public port", + "name": "publicport", + "type": "string" } ], "type": "list" }, - { - "description": "name of the global load balancer rule", - "name": "name", - "type": "string" - }, - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - {}, - { - "description": "the project name of the load balancer", - "name": "project", - "type": "string" - }, - { - "description": "the description of the global load balancer rule", - "name": "description", - "type": "string" - }, { "description": "Region Id in which global load balancer is created", "name": "regionid", "type": "integer" }, - { - "description": "Load balancing method used for the global load balancer", - "name": "gslblbmethod", - "type": "string" - }, - { - "description": "the domain ID of the load balancer rule", - "name": "domainid", - "type": "string" - }, - { - "description": "the account of the load balancer rule", - "name": "account", - "type": "string" - }, - { - "description": "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" - } + {} ] }, { @@ -66847,20 +68488,18 @@ "name": "createCondition", "params": [ { - "description": "ID of the Counter.", + "description": "Threshold value.", "length": 255, - "name": "counterid", - "related": "createCounter,listCounters", + "name": "threshold", "required": true, - "type": "uuid" + "type": "long" }, { - "description": "the domain ID of the account.", + "description": "Relational Operator to be used with threshold.", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", - "required": false, - "type": "uuid" + "name": "relationaloperator", + "required": true, + "type": "string" }, { "description": "the account of the condition. Must be used with the domainId parameter.", @@ -66870,52 +68509,47 @@ "type": "string" }, { - "description": "Threshold value.", + "description": "ID of the Counter.", "length": 255, - "name": "threshold", + "name": "counterid", + "related": "createCounter,listCounters", "required": true, - "type": "long" + "type": "uuid" }, { - "description": "Relational Operator to be used with threshold.", + "description": "the domain ID of the account.", "length": 255, - "name": "relationaloperator", - "required": true, - "type": "string" + "name": "domainid", + "related": "listDomainChildren,listDomains", + "required": false, + "type": "uuid" } ], "related": "", "response": [ { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "zone id of counter", + "name": "zoneid", "type": "string" }, { - "description": "the project name of the Condition", - "name": "project", + "description": "the id of the Condition", + "name": "id", "type": "string" }, { - "description": "Relational Operator to be used with threshold.", - "name": "relationaloperator", + "description": "the project id of the Condition.", + "name": "projectid", "type": "string" }, - {}, - {}, - { - "description": "Threshold Value for the counter.", - "name": "threshold", - "type": "long" - }, { - "description": "Details of the Counter.", - "name": "counter", - "type": "list" + "description": "the owner of the Condition.", + "name": "account", + "type": "string" }, { - "description": "the domain id of the Condition owner", - "name": "domainid", + "description": "the domain name of the owner.", + "name": "domain", "type": "string" }, { @@ -66924,29 +68558,36 @@ "type": "integer" }, { - "description": "the id of the Condition", - "name": "id", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, { - "description": "the domain name of the owner.", - "name": "domain", - "type": "string" + "description": "Threshold Value for the counter.", + "name": "threshold", + "type": "long" }, { - "description": "the project id of the Condition.", - "name": "projectid", + "description": "the project name of the Condition", + "name": "project", "type": "string" }, { - "description": "zone id of counter", - "name": "zoneid", + "description": "Relational Operator to be used with threshold.", + "name": "relationaloperator", "type": "string" }, { - "description": "the owner of the Condition.", - "name": "account", + "description": "the domain id of the Condition owner", + "name": "domainid", "type": "string" + }, + {}, + { + "description": "Details of the Counter.", + "name": "counter", + "type": "list" } ] }, @@ -66956,33 +68597,33 @@ "name": "listProjects", "params": [ { - "description": "", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "pagesize", + "name": "domainid", + "related": "listDomainChildren,listDomains", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "list projects by project ID", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "id", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", + "name": "account", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "list projects by display text", + "description": "comma separated list of project details requested, value can be a list of [ all, resource, min]", "length": 255, - "name": "displaytext", + "name": "details", "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", + "description": "", "length": 255, - "name": "listall", + "name": "pagesize", "required": false, - "type": "boolean" + "type": "integer" }, { "description": "List by keyword", @@ -66992,11 +68633,26 @@ "type": "string" }, { - "description": "comma separated list of project details requested, value can be a list of [ all, resource, min]", + "description": "", "length": 255, - "name": "details", + "name": "page", "required": false, - "type": "list" + "type": "integer" + }, + { + "description": "list projects by name", + "length": 255, + "name": "name", + "required": false, + "type": "string" + }, + { + "description": "list projects by project ID", + "length": 255, + "name": "id", + "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", + "required": false, + "type": "uuid" }, { "description": "list projects by state", @@ -67005,6 +68661,13 @@ "required": false, "type": "string" }, + { + "description": "List projects by username", + "length": 255, + "name": "username", + "required": false, + "type": "string" + }, { "description": "flag to display the resource icon for projects", "length": 255, @@ -67013,86 +68676,206 @@ "type": "boolean" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "account", + "name": "isrecursive", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "list only resources belonging to the domain specified", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", + "name": "listall", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "List projects by username", + "description": "List projects by tags (key/value pairs)", "length": 255, - "name": "username", + "name": "tags", "required": false, - "type": "string" + "type": "map" }, { - "description": "list projects by name", + "description": "list projects by display text", "length": 255, - "name": "name", + "name": "displaytext", "required": false, "type": "string" + } + ], + "related": "listProjectAccounts,activateProject,suspendProject,updateProject", + "response": [ + { + "description": "the total memory (in MB) the project can own", + "name": "memorylimit", + "type": "string" + }, + { + "description": "the total number of templates which can be created by this project", + "name": "templatelimit", + "type": "string" + }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the domain name where the project belongs to", + "name": "domain", + "type": "string" + }, + { + "description": "the date this project was created", + "name": "created", + "type": "date" + }, + { + "description": "the total memory (in MB) owned by project", + "name": "memorytotal", + "type": "long" + }, + { + "description": "the total number of networks available to be created for this project", + "name": "networkavailable", + "type": "string" + }, + {}, + { + "description": "the total memory (in MB) available to be created for this project", + "name": "memoryavailable", + "type": "string" + }, + { + "description": "the domain id the project belongs to", + "name": "domainid", + "type": "string" + }, + { + "description": "the total number of vpcs owned by project", + "name": "vpctotal", + "type": "long" + }, + { + "description": "the state of the project", + "name": "state", + "type": "string" + }, + { + "description": "the total secondary storage space (in GiB) owned by project", + "name": "secondarystoragetotal", + "type": "float" + }, + { + "description": "the total number of snapshots available for this project", + "name": "snapshotavailable", + "type": "string" + }, + { + "description": "the total number of networks the project can own", + "name": "networklimit", + "type": "string" + }, + { + "description": "the total number of vpcs available to be created for this project", + "name": "vpcavailable", + "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 stopped for this project", + "name": "vmstopped", + "type": "integer" + }, + { + "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) the project can own", + "name": "secondarystoragelimit", + "type": "string" + }, + {}, + { + "description": "the total volume available for this project", + "name": "volumeavailable", + "type": "string" + }, + { + "description": "the total secondary storage space (in GiB) available to be used for this project", + "name": "secondarystorageavailable", + "type": "string" + }, + { + "description": "the total volume which can be used by this project", + "name": "volumelimit", + "type": "string" + }, + { + "description": "the project account name of the project", + "name": "projectaccountname", + "type": "string" + }, + { + "description": "the total number of public ip addresses available for this project to acquire", + "name": "ipavailable", + "type": "string" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, + "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 total primary storage space (in GiB) owned by project", + "name": "primarystoragetotal", + "type": "long" }, { - "description": "List projects by tags (key/value pairs)", - "length": 255, - "name": "tags", - "required": false, - "type": "map" - } - ], - "related": "listProjectAccounts,activateProject,suspendProject,updateProject", - "response": [ + "description": "the total volume being used by this project", + "name": "volumetotal", + "type": "long" + }, { - "description": "the total number of templates which can be created by this project", - "name": "templatelimit", + "description": "the total number of networks owned by project", + "name": "networktotal", + "type": "long" + }, + { + "description": "the total primary storage space (in GiB) available to be used for this project", + "name": "primarystorageavailable", "type": "string" }, { - "description": "the total number of public ip addresses allocated for this project", - "name": "iptotal", - "type": "long" + "description": "the total number of cpu cores the project can own", + "name": "cpulimit", + "type": "string" }, { - "description": "the total number of virtual machines that can be deployed by this project", - "name": "vmlimit", + "description": "the total number of cpu cores available to be created for this project", + "name": "cpuavailable", "type": "string" }, { - "description": "the total primary storage space (in GiB) the project can own", - "name": "primarystoragelimit", + "description": "the total number of virtual machines that can be deployed by this project", + "name": "vmlimit", "type": "string" }, { - "description": "the name of the project", - "name": "name", + "description": "the total number of public ip addresses this project can acquire", + "name": "iplimit", "type": "string" }, { - "description": "the total number of snapshots stored by this project", - "name": "snapshottotal", + "description": "the total number of public ip addresses allocated for this project", + "name": "iptotal", "type": "long" }, { @@ -67100,28 +68883,28 @@ "name": "tags", "response": [ { - "description": "the project name where tag belongs to", - "name": "project", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { @@ -67130,18 +68913,18 @@ "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "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 account associated with the tag", - "name": "account", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { @@ -67152,14 +68935,19 @@ ], "type": "list" }, + { + "description": "the total number of virtual machines deployed by this project", + "name": "vmtotal", + "type": "long" + }, { "description": "the total number of templates which have been created by this project", "name": "templatetotal", "type": "long" }, { - "description": "the total volume available for this project", - "name": "volumeavailable", + "description": "the total primary storage space (in GiB) the project can own", + "name": "primarystoragelimit", "type": "string" }, { @@ -67168,317 +68956,509 @@ "type": "integer" }, { - "description": "the total volume which can be used by this project", - "name": "volumelimit", + "description": "the total number of vpcs the project can own", + "name": "vpclimit", "type": "string" }, { - "description": "the total number of virtual machines deployed by this project", - "name": "vmtotal", + "description": "the id of the project", + "name": "id", + "type": "string" + }, + { + "description": "the total number of snapshots stored by this project", + "name": "snapshottotal", "type": "long" }, { - "description": "the domain id the project belongs to", - "name": "domainid", + "description": "the total number of snapshots which can be stored by this project", + "name": "snapshotlimit", "type": "string" }, { - "description": "the total volume being used by this project", - "name": "volumetotal", + "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 project", + "name": "cputotal", "type": "long" }, { - "description": "the total primary storage space (in GiB) available to be used for this project", - "name": "primarystorageavailable", + "description": "the account name of the project's owners", + "name": "owner", + "type": "list" + }, + { + "description": "the name of the project", + "name": "name", "type": "string" }, { - "description": "the project account name of the project", - "name": "projectaccountname", + "description": "the displaytext of the project", + "name": "displaytext", "type": "string" + } + ], + "since": "3.0.0" + }, + { + "description": "Creates an account", + "isasync": false, + "name": "createAccount", + "params": [ + { + "description": "details for account used to store specific parameters", + "length": 255, + "name": "accountdetails", + "required": false, + "type": "map" }, { - "description": "the total secondary storage space (in GiB) available to be used for this project", - "name": "secondarystorageavailable", + "description": "Creates the account under the specified role.", + "length": 255, + "name": "roleid", + "related": "importRole,listRoles,updateRole", + "required": false, + "type": "uuid" + }, + { + "description": "Network domain for the account's networks", + "length": 255, + "name": "networkdomain", + "required": false, "type": "string" }, { - "description": "the id of the project", - "name": "id", + "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": "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 total memory (in MB) the project can own", - "name": "memorylimit", + "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 total number of networks owned by project", - "name": "networktotal", - "type": "long" + "description": "Account UUID, required for adding account from external provisioning system", + "length": 255, + "name": "accountid", + "required": false, + "type": "string" }, { - "description": "the total number of snapshots which can be stored by this project", - "name": "snapshotlimit", + "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 total number of networks the project can own", - "name": "networklimit", + "description": "User UUID, required for adding account from external provisioning system", + "length": 255, + "name": "userid", + "required": false, "type": "string" }, { - "description": "the domain name where the project belongs to", - "name": "domain", + "description": "email", + "length": 255, + "name": "email", + "required": true, "type": "string" }, { - "description": "the total primary storage space (in GiB) owned by project", - "name": "primarystoragetotal", - "type": "long" + "description": "lastname", + "length": 255, + "name": "lastname", + "required": true, + "type": "string" }, { - "description": "the total number of virtual machines available for this project to acquire", - "name": "vmavailable", + "description": "firstname", + "length": 255, + "name": "firstname", + "required": true, "type": "string" }, { - "description": "the total number of public ip addresses this project can acquire", - "name": "iplimit", + "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": "enableAccount,listAccounts,listAccounts", + "response": [ + { + "description": "id of the Domain the account belongs to", + "name": "domainid", "type": "string" }, { - "description": "the total number of cpu cores available to be created for this project", - "name": "cpuavailable", + "description": "the total secondary storage space (in GiB) available to be used for this account", + "name": "secondarystorageavailable", "type": "string" }, { - "description": "the total number of cpu cores owned by project", - "name": "cputotal", + "description": "the total volume which can be used by this account", + "name": "volumelimit", + "type": "string" + }, + { + "description": "the total primary storage space (in GiB) owned by account", + "name": "primarystoragetotal", "type": "long" }, { - "description": "the total number of cpu cores the project can own", - "name": "cpulimit", + "description": "the total number of vpcs the account can own", + "name": "vpclimit", "type": "string" }, {}, { - "description": "the displaytext of the project", - "name": "displaytext", - "type": "string" + "description": "the total memory (in MB) owned by account", + "name": "memorytotal", + "type": "long" }, { - "description": "the date this project was created", - "name": "created", - "type": "date" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the total number of templates available to be created by this project", - "name": "templateavailable", + "description": "the total number of templates which can be created by this account", + "name": "templatelimit", "type": "string" }, { - "description": "the total number of vpcs the project can own", - "name": "vpclimit", + "description": "the default zone of the account", + "name": "defaultzoneid", "type": "string" }, { - "description": "the total secondary storage space (in GiB) owned by project", - "name": "secondarystoragetotal", - "type": "float" + "description": "the name of the account", + "name": "name", + "type": "string" + }, + { + "description": "the total number of public ip addresses available for this account to acquire", + "name": "ipavailable", + "type": "string" }, {}, { - "description": "the total memory (in MB) available to be created for this project", + "description": "the total memory (in MB) available to be created for this account", "name": "memoryavailable", "type": "string" }, { - "description": "the total secondary storage space (in GiB) the project can own", + "description": "the total number of snapshots which can be stored by this account", + "name": "snapshotlimit", + "type": "string" + }, + { + "description": "the total number of snapshots available for this account", + "name": "snapshotavailable", + "type": "string" + }, + { + "description": "the total number of virtual machines that can be deployed by this account", + "name": "vmlimit", + "type": "string" + }, + { + "description": "the total secondary storage space (in GiB) the account can own", "name": "secondarystoragelimit", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the network domain", + "name": "networkdomain", "type": "string" }, { - "description": "the total memory (in MB) owned by project", - "name": "memorytotal", - "type": "long" + "description": "name of the Domain the account belongs to", + "name": "domain", + "type": "string" }, { - "description": "the total number of vpcs available to be created for this project", - "name": "vpcavailable", + "description": "the total number of networks the account can own", + "name": "networklimit", "type": "string" }, { - "description": "the total number of snapshots available for this project", - "name": "snapshotavailable", + "description": "true if account is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "the total number of cpu cores available to be created for this account", + "name": "cpuavailable", "type": "string" }, { - "description": "the total number of 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 state of the project", - "name": "state", + "description": "the ID of the role", + "name": "roleid", "type": "string" }, { - "description": "the account name of the project's owners", - "name": "owner", - "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 id of the account", + "name": "id", + "type": "string" }, { - "description": "the total number of networks available to be created for this project", + "description": "the total number of networks available to be created for this account", "name": "networkavailable", "type": "string" }, { - "description": "the total number of vpcs owned by project", - "name": "vpctotal", - "type": "long" + "description": "details for the account", + "name": "accountdetails", + "type": "map" }, { - "description": "the total number of virtual machines stopped for this project", - "name": "vmstopped", + "description": "account type (admin, domain-admin, user)", + "name": "accounttype", "type": "integer" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - } - ], - "since": "3.0.0" - }, - { - "description": "Creates an account", - "isasync": false, - "name": "createAccount", - "params": [ + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" + }, { - "description": "firstname", - "length": 255, - "name": "firstname", - "required": true, + "description": "the total primary storage space (in GiB) available to be used for this account", + "name": "primarystorageavailable", + "type": "string" + }, + { + "description": "the total number of public ip addresses this account can acquire", + "name": "iplimit", + "type": "string" + }, + { + "description": "the total primary storage space (in GiB) the account can own", + "name": "primarystoragelimit", + "type": "string" + }, + { + "description": "the total secondary storage space (in GiB) owned by account", + "name": "secondarystoragetotal", + "type": "float" + }, + { + "description": "the state of the account", + "name": "state", "type": "string" }, { - "description": "Name of the account to be created. The user will be added to this newly created account. If no account is specified, the username will be used as the account name.", - "length": 255, - "name": "account", - "required": false, + "description": "the list of users associated with account", + "name": "user", + "response": [ + { + "description": "the user state", + "name": "state", + "type": "string" + }, + { + "description": "the ID of the role", + "name": "roleid", + "type": "string" + }, + { + "description": "the boolean value representing if the updating target is in caller's child domain", + "name": "iscallerchilddomain", + "type": "boolean" + }, + { + "description": "the user lastname", + "name": "lastname", + "type": "string" + }, + { + "description": "the date and time the user account was created", + "name": "created", + "type": "date" + }, + { + "description": "the domain name of the user", + "name": "domain", + "type": "string" + }, + { + "description": "the account name of the user", + "name": "account", + "type": "string" + }, + { + "description": "the account type of the user", + "name": "accounttype", + "type": "integer" + }, + { + "description": "the user firstname", + "name": "firstname", + "type": "string" + }, + { + "description": "the domain ID of the user", + "name": "domainid", + "type": "string" + }, + { + "description": "the source type of the user in lowercase, such as native, ldap, saml2", + "name": "usersource", + "type": "string" + }, + { + "description": "the user name", + "name": "username", + "type": "string" + }, + { + "description": "the user email address", + "name": "email", + "type": "string" + }, + { + "description": "the type of the role", + "name": "roletype", + "type": "string" + }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the timezone user was created in", + "name": "timezone", + "type": "string" + }, + { + "description": "true if user is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "the account ID of the user", + "name": "accountid", + "type": "string" + }, + { + "description": "the name of the role", + "name": "rolename", + "type": "string" + }, + { + "description": "the api key of the user", + "name": "apikey", + "type": "string" + }, + { + "description": "the user ID", + "name": "id", + "type": "string" + }, + { + "description": "the secret key of the user", + "name": "secretkey", + "type": "string" + } + ], + "type": "list" + }, + { + "description": "the total memory (in MB) the account can own", + "name": "memorylimit", "type": "string" }, { - "description": "lastname", - "length": 255, - "name": "lastname", - "required": true, + "description": "the total number of projects the account can own", + "name": "projectlimit", "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": "short" + "description": "the total number of virtual machines stopped for this account", + "name": "vmstopped", + "type": "integer" }, { - "description": "Clear text password (Default hashed to SHA256SALT). If you wish to use any other hashing algorithm, you would need to write a custom authentication adapter See Docs section.", - "length": 255, - "name": "password", - "required": true, - "type": "string" + "description": "the date when this account was created", + "name": "created", + "type": "date" }, { - "description": "User UUID, required for adding account from external provisioning system", - "length": 255, - "name": "userid", - "required": false, + "description": "path of the Domain the account belongs to", + "name": "domainpath", "type": "string" }, { - "description": "Unique username.", - "length": 255, - "name": "username", - "required": true, + "description": "the total number of projects available for administration by this account", + "name": "projectavailable", "type": "string" }, { - "description": "Creates the user under the specified domain.", - "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", - "required": false, - "type": "uuid" - }, - { - "description": "Creates the account under the specified role.", - "length": 255, - "name": "roleid", - "related": "importRole,listRoles,updateRole", - "required": false, - "type": "uuid" - }, - { - "description": "Network domain for the account's networks", - "length": 255, - "name": "networkdomain", - "required": false, - "type": "string" + "description": "the list of acl groups that account belongs to", + "name": "groups", + "type": "list" }, { - "description": "email", - "length": 255, - "name": "email", - "required": true, - "type": "string" + "description": "the total number of snapshots stored by this account", + "name": "snapshottotal", + "type": "long" }, { - "description": "Account UUID, required for adding account from external provisioning system", - "length": 255, - "name": "accountid", - "required": false, - "type": "string" + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" }, { - "description": "Specifies a timezone for this command. For more information on the timezone parameter, see Time Zone Format.", - "length": 255, - "name": "timezone", - "required": false, + "description": "the type of the role (Admin, ResourceAdmin, DomainAdmin, User)", + "name": "roletype", "type": "string" }, { - "description": "details for account used to store specific parameters", - "length": 255, - "name": "accountdetails", - "required": false, - "type": "map" - } - ], - "related": "enableAccount,listAccounts,listAccounts", - "response": [ - { - "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 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 volume available for this account", @@ -67486,13 +69466,8 @@ "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) the account can own", - "name": "secondarystoragelimit", + "description": "the total number of cpu cores the account can own", + "name": "cpulimit", "type": "string" }, { @@ -67501,64 +69476,39 @@ "type": "integer" }, { - "description": "the default zone of the account", - "name": "defaultzoneid", - "type": "string" - }, - { - "description": "true if account is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "name of the Domain the account belongs to", - "name": "domain", + "description": "the name of the role", + "name": "rolename", "type": "string" }, { - "description": "true if the account requires cleanup", - "name": "iscleanuprequired", - "type": "boolean" - }, - { - "description": "the total number of virtual machines deployed by this account", - "name": "vmtotal", + "description": "the total number of projects being administrated by this account", + "name": "projecttotal", "type": "long" }, { - "description": "the total number of networks available to be created for this account", - "name": "networkavailable", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the total number of cpu cores owned by account", + "name": "cputotal", + "type": "long" }, { - "description": "the name of the account", - "name": "name", + "description": "the total number of virtual machines available for this account to acquire", + "name": "vmavailable", "type": "string" }, { - "description": "the date when this account was created", - "name": "created", - "type": "date" - }, - { - "description": "the total memory (in MB) the account can own", - "name": "memorylimit", + "description": "the total number of vpcs available to be created for this account", + "name": "vpcavailable", "type": "string" }, { - "description": "the total primary storage space (in GiB) the account can own", - "name": "primarystoragelimit", - "type": "string" + "description": "the total number of networks owned by account", + "name": "networktotal", + "type": "long" }, { - "description": "the total volume which can be used by this account", - "name": "volumelimit", - "type": "string" + "description": "true if the account requires cleanup", + "name": "iscleanuprequired", + "type": "boolean" }, { "description": "the total number of templates which have been created by this account", @@ -67566,360 +69516,468 @@ "type": "long" }, { - "description": "the state of the account", - "name": "state", + "description": "the total number of templates available to be created by this account", + "name": "templateavailable", "type": "string" }, { - "description": "details for the account", - "name": "accountdetails", - "type": "map" - }, - { - "description": "account type (admin, domain-admin, user)", - "name": "accounttype", - "type": "short" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the total primary storage space (in GiB) available to be used for this account", - "name": "primarystorageavailable", - "type": "string" - }, + "description": "the total number of public ip addresses allocated for this account", + "name": "iptotal", + "type": "long" + } + ] + }, + { + "description": "Revert VM from a vmsnapshot.", + "isasync": true, + "name": "revertToVMSnapshot", + "params": [ { - "description": "the total number of snapshots which can be stored by this account", - "name": "snapshotlimit", - "type": "string" - }, + "description": "The ID of the vm snapshot", + "length": 255, + "name": "vmsnapshotid", + "related": "listVMSnapshot,createVMSnapshot", + "required": true, + "type": "uuid" + } + ], + "related": "migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,deployVirtualMachine,destroyVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance", + "response": [ { - "description": "the total secondary storage space (in GiB) available to be used for this account", - "name": "secondarystorageavailable", + "description": "the ID of the availablility zone for the virtual machine", + "name": "zoneid", "type": "string" }, { - "description": "the total number of virtual machines available for this account to acquire", - "name": "vmavailable", + "description": "the user's name who deployed the virtual machine", + "name": "username", "type": "string" }, { - "description": "the total number of cpu cores owned by account", - "name": "cputotal", + "description": "the memory used by the VM in KiB", + "name": "memorykbs", "type": "long" }, { - "description": "the total secondary storage space (in GiB) owned by account", - "name": "secondarystoragetotal", - "type": "float" + "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 incoming network traffic on the VM in KiB", + "name": "networkkbsread", "type": "long" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the total volume being used by this account", - "name": "volumetotal", - "type": "long" + "description": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" }, { - "description": "the type of the role (Admin, ResourceAdmin, DomainAdmin, User)", - "name": "roletype", - "type": "string" + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" }, + {}, { - "description": "the total memory (in MB) available to be created for this account", - "name": "memoryavailable", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, { - "description": "the total number of vpcs available to be created for this account", - "name": "vpcavailable", + "description": "the project name of the vm", + "name": "project", "type": "string" }, { - "description": "the total number of templates which can be created by this account", - "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 cpu cores available to be created for this account", - "name": "cpuavailable", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "the total primary storage space (in GiB) owned by account", - "name": "primarystoragetotal", + "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 account", - "name": "snapshotavailable", + "description": "the group name of the virtual machine", + "name": "group", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "Guest vm Boot Type", + "name": "boottype", + "type": "string" }, { - "description": "the total number of networks the account can own", - "name": "networklimit", + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the state of the virtual machine", + "name": "state", "type": "string" }, { - "description": "the total number of virtual machines stopped for this account", - "name": "vmstopped", - "type": "integer" + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" }, { - "description": "the total number of snapshots stored by this account", - "name": "snapshottotal", - "type": "long" + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" }, { - "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": "short" + "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 isolation uri of the nic", + "name": "isolationuri", + "type": "string" }, { - "description": "the timezone user was created in", - "name": "timezone", + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", "type": "string" }, { - "description": "the account name of the user", - "name": "account", + "description": "the ID of the corresponding network", + "name": "networkid", "type": "string" }, { - "description": "the api key of the user", - "name": "apikey", + "description": "true if nic is default, false otherwise", + "name": "macaddress", "type": "string" }, { - "description": "the domain name of the user", - "name": "domain", + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { - "description": "true if user is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" }, { - "description": "the user state", - "name": "state", + "description": "the ID of the nic", + "name": "id", "type": "string" }, { - "description": "the ID of the role", - "name": "roleid", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "the boolean value representing if the updating target is in caller's child domain", - "name": "iscallerchilddomain", - "type": "boolean" + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", + "type": "string" }, { - "description": "the account ID of the user", - "name": "accountid", + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "the IPv6 address of network", + "name": "ip6address", + "type": "string" + }, + { + "description": "the name of the corresponding network", + "name": "networkname", + "type": "string" + }, + { + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "type": "string" }, { - "description": "the user lastname", - "name": "lastname", + "description": "the ip address of the nic", + "name": "ipaddress", + "type": "string" + }, + { + "description": "the traffic type of the nic", + "name": "traffictype", + "type": "string" + }, + { + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", + "type": "string" + }, + { + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "the gateway of the nic", + "name": "gateway", + "type": "string" + }, + { + "description": "the type of the nic", + "name": "type", + "type": "string" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + }, + { + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", + "type": "string" + }, + { + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", + "type": "string" + }, + { + "description": "the netmask of the nic", + "name": "netmask", + "type": "string" + }, + { + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", "type": "string" - }, + } + ], + "type": "set" + }, + { + "description": "the account associated with the virtual machine", + "name": "account", + "type": "string" + }, + { + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" + }, + { + "description": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", + "response": [ { - "description": "the user email address", - "name": "email", + "description": "the ID of the affinity group", + "name": "id", "type": "string" }, { - "description": "the secret key of the user", - "name": "secretkey", + "description": "the project ID of the affinity group", + "name": "projectid", "type": "string" }, { - "description": "the user name", - "name": "username", - "type": "string" + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" }, { - "description": "the name of the role", - "name": "rolename", + "description": "the account owning the affinity group", + "name": "account", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the domain ID of the affinity group", + "name": "domainid", + "type": "string" }, { - "description": "the user ID", - "name": "id", + "description": "the name of the affinity group", + "name": "name", "type": "string" }, { - "description": "the domain ID of the user", - "name": "domainid", + "description": "the type of the affinity group", + "name": "type", "type": "string" }, { - "description": "the type of the role", - "name": "roletype", + "description": "the description of the affinity group", + "name": "description", "type": "string" }, { - "description": "the source type of the user in lowercase, such as native, ldap, saml2", - "name": "usersource", + "description": "the project name of the affinity group", + "name": "project", "type": "string" }, { - "description": "the user firstname", - "name": "firstname", + "description": "the domain name of the affinity group", + "name": "domain", "type": "string" } ], - "type": "list" - }, - { - "description": "the total number of projects the account can own", - "name": "projectlimit", - "type": "string" + "type": "set" }, { - "description": "the ID of the role", - "name": "roleid", + "description": "the group ID of the virtual machine", + "name": "groupid", "type": "string" }, { - "description": "the list of acl groups that account belongs to", - "name": "groups", - "type": "list" - }, - { - "description": "the total number of projects available for administration by this account", - "name": "projectavailable", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the total number of projects being administrated by this account", - "name": "projecttotal", + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", "type": "long" }, { - "description": "the total number of public ip addresses available for this account to acquire", - "name": "ipavailable", - "type": "string" - }, - { - "description": "the total number of cpu cores the account can own", - "name": "cpulimit", - "type": "string" - }, - { - "description": "the total number of vpcs the account can own", - "name": "vpclimit", - "type": "string" - }, - { - "description": "the network domain", - "name": "networkdomain", + "description": "the name of the host for the virtual machine", + "name": "hostname", "type": "string" }, { - "description": "the id of the account", - "name": "id", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "path of the Domain the account belongs to", - "name": "domainpath", + "description": "OS name of the vm", + "name": "osdisplayname", "type": "string" }, { - "description": "the total number of vpcs owned by account", - "name": "vpctotal", - "type": "long" + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" }, { - "description": "the name of the role", - "name": "rolename", + "description": "State of the Service from LB rule", + "name": "servicestate", "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Os type ID of the virtual machine", + "name": "guestosid", "type": "string" }, { - "description": "the total number of virtual machines that can be deployed by this account", - "name": "vmlimit", + "description": "the project id of the vm", + "name": "projectid", "type": "string" }, { - "description": "the total number of templates available to be created by this account", - "name": "templateavailable", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "the total memory (in MB) owned by account", - "name": "memorytotal", - "type": "long" + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" }, - {}, - { - "description": "the total number of networks owned by account", - "name": "networktotal", - "type": "long" - } - ] - }, - { - "description": "Revert VM from a vmsnapshot.", - "isasync": true, - "name": "revertToVMSnapshot", - "params": [ - { - "description": "The ID of the vm snapshot", - "length": 255, - "name": "vmsnapshotid", - "related": "listVMSnapshot,createVMSnapshot", - "required": true, - "type": "uuid" - } - ], - "related": "migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,deployVirtualMachine,destroyVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance", - "response": [ { - "description": "the account associated with the virtual machine", - "name": "account", + "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 UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the name of the disk offering of the virtual machine", + "name": "diskofferingname", "type": "string" }, { @@ -67927,126 +69985,94 @@ "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 list of ingress rules associated with the security group", - "name": "ingressrule", + "description": "the list of resource tags associated with the rule", + "name": "tags", "response": [ { - "description": "account owning the security group rule", - "name": "account", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" + "description": "the account associated with the tag", + "name": "account", + "type": "string" }, { - "description": "the 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 account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - } - ], - "type": "set" + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" }, { - "description": "the id of the security group rule", - "name": "ruleid", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" + "description": "tag key name", + "name": "key", + "type": "string" }, { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the protocol of the security group rule", - "name": "protocol", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" + "description": "id of the resource", + "name": "resourceid", + "type": "string" }, { - "description": "security group name", - "name": "securitygroupname", + "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 ID of the domain associated with the tag", + "name": "domainid", + "type": "string" } ], "type": "set" }, { - "description": "the list of egress rules associated with the security group", - "name": "egressrule", + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" + }, + { + "description": "the project id of the group", + "name": "projectid", + "type": "string" + }, + { + "description": "the account owning the security group", + "name": "account", + "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", + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "security group name", + "name": "securitygroupname", "type": "string" }, { @@ -68054,8 +70080,8 @@ "name": "tags", "response": [ { - "description": "the domain associated with the tag", - "name": "domain", + "description": "tag value", + "name": "value", "type": "string" }, { @@ -68064,13 +70090,8 @@ "type": "string" }, { - "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" }, { @@ -68084,8 +70105,8 @@ "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "tag key name", + "name": "key", "type": "string" }, { @@ -68102,18 +70123,28 @@ "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", + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "account owning the security group rule", + "name": "account", "type": "string" }, { - "description": "the type of the ICMP message response", - "name": "icmptype", + "description": "the code for the ICMP message response", + "name": "icmpcode", "type": "integer" }, { @@ -68122,741 +70153,361 @@ "type": "integer" }, { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", + "description": "the id of the security group rule", + "name": "ruleid", "type": "string" }, { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "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 starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "account owning the security group rule", - "name": "account", + "description": "the protocol of the security group rule", + "name": "protocol", "type": "string" } ], "type": "set" }, { - "description": "the project name of the group", - "name": "project", + "description": "the domain ID of the security group", + "name": "domainid", "type": "string" }, { - "description": "the 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" + "description": "the description of the security group", + "name": "description", + "type": "string" }, { - "description": "the domain ID of the security group", - "name": "domainid", + "description": "the project name of the group", + "name": "project", "type": "string" }, { - "description": "the ID of the security group", - "name": "id", + "description": "the domain name of the security group", + "name": "domain", "type": "string" }, { - "description": "the name of the security group", - "name": "name", + "description": "the ID of the security group", + "name": "id", "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": "customer associated with the tag", - "name": "customer", + "description": "security group name", + "name": "securitygroupname", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the id of the security group rule", + "name": "ruleid", "type": "string" }, { - "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 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 type of the ICMP message response", + "name": "icmptype", + "type": "integer" }, { - "description": "tag key name", - "name": "key", - "type": "string" + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" }, { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "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 the tag belongs to", - "name": "projectid", + "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 code for the ICMP message response", + "name": "icmpcode", + "type": "integer" }, { - "description": "id of the resource", - "name": "resourceid", + "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 project id of the group", - "name": "projectid", - "type": "string" - }, - { - "description": "the description of the security group", - "name": "description", - "type": "string" } ], "type": "set" }, { - "description": "the name of the host for the virtual machine", - "name": "hostname", + "description": "the user's ID who deployed the virtual machine", + "name": "userid", "type": "string" }, {}, { - "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 ID of the ISO attached to the virtual machine", - "name": "isoid", - "type": "string" - }, - { - "description": "the pool type of the virtual machine", - "name": "pooltype", - "type": "string" - }, - { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", "type": "string" }, + {}, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", + "description": "the read (IO) of disk on the VM", + "name": "diskioread", "type": "long" }, - { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", - "type": "string" - }, { "description": "the name of the virtual machine", "name": "name", "type": "string" }, { - "description": "the write (io) of disk on the vm", - "name": "diskiowrite", + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", "type": "long" }, - { - "description": "OS type id of the vm", - "name": "ostypeid", - "type": "string" - }, - { - "description": "the ID of the availablility zone for the virtual machine", - "name": "zoneid", - "type": "string" - }, - { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" - }, - { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", - "type": "string" - }, - {}, - { - "description": "the name of the template for the virtual machine", - "name": "templatename", - "type": "string" - }, { "description": "the name of the ISO attached to the virtual machine", "name": "isoname", "type": "string" }, - { - "description": "the password (if exists) of the virtual machine", - "name": "password", - "type": "string" - }, { "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", "name": "isdynamicallyscalable", "type": "boolean" }, { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", - "type": "string" - }, - { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", - "type": "string" - }, - { - "description": "Guest vm Boot Type", - "name": "boottype", - "type": "string" - }, - { - "description": "the state of the virtual machine", - "name": "state", - "type": "string" - }, - { - "description": "the incoming network traffic on the vm", - "name": "networkkbsread", - "type": "long" - }, - { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", "type": "string" }, - { - "description": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" - }, - { - "description": "the speed of each cpu", - "name": "cpuspeed", - "type": "integer" - }, { "description": "the ID of the domain in which the virtual machine exists", "name": "domainid", "type": "string" }, { - "description": "the target memory in vm", - "name": "memorytargetkbs", - "type": "long" + "description": "OS type id of the vm", + "name": "ostypeid", + "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", + "description": "the VM's disk read in KiB", + "name": "diskkbsread", "type": "long" }, { - "description": "the read (io) of disk on the vm", - "name": "diskioread", + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", "type": "long" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", "type": "boolean" }, { - "description": "the project id of the vm", - "name": "projectid", - "type": "string" - }, - { - "description": "the group name of the virtual machine", - "name": "group", - "type": "string" - }, - { - "description": "the list of resource tags associated", - "name": "tags", - "response": [ - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", "type": "string" }, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", + "description": "Guest vm Boot Mode", + "name": "bootmode", "type": "string" }, { - "description": "OS name of the vm", - "name": "osdisplayname", + "description": "the ID of the host for the virtual machine", + "name": "hostid", "type": "string" }, { - "description": "the write (bytes) of disk on the vm", - "name": "diskkbswrite", - "type": "long" - }, - { - "description": "the read (bytes) of disk on the vm", - "name": "diskkbsread", + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", "type": "long" }, { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" - }, - { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", - "type": "string" - }, - { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", "type": "string" }, { - "description": "the outgoing network traffic on the host", - "name": "networkkbswrite", - "type": "long" - }, - { - "description": "the vgpu type used by the virtual machine", - "name": "vgpu", + "description": "the pool type of the virtual machine", + "name": "pooltype", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "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": "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 ID of the virtual machine", + "name": "id", "type": "string" }, { - "description": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", - "response": [ - { - "description": "the domain ID of the affinity group", - "name": "domainid", - "type": "string" - }, - { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" - }, - { - "description": "the name of the affinity group", - "name": "name", - "type": "string" - }, - { - "description": "the project ID of the affinity group", - "name": "projectid", - "type": "string" - }, - { - "description": "the project name of the affinity group", - "name": "project", - "type": "string" - }, - { - "description": "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 type of the affinity group", - "name": "type", - "type": "string" - }, - { - "description": "the domain name of the affinity group", - "name": "domain", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", "type": "boolean" }, { - "description": "the internal memory that's free in vm or zero if it can not be calculated", - "name": "memoryintfreekbs", - "type": "long" - }, - { - "description": "Guest vm Boot Mode", - "name": "bootmode", - "type": "string" - }, - { - "description": "the list of nics associated with vm", - "name": "nic", - "response": [ - { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", - "type": "string" - }, - { - "description": "the type of the nic", - "name": "type", - "type": "string" - }, - { - "description": "Type of adapter if available", - "name": "adaptertype", - "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 ip address of the nic", - "name": "ipaddress", - "type": "string" - }, - { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "the name of the corresponding network", - "name": "networkname", - "type": "string" - }, - { - "description": "Id of the NSX Logical Switch (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 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 VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - }, - { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "true if nic is default, false otherwise", - "name": "macaddress", - "type": "string" - }, - { - "description": "the traffic type of the nic", - "name": "traffictype", - "type": "string" - }, - { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" - }, - { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "description": "the gateway of the nic", - "name": "gateway", - "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 netmask of the nic", - "name": "netmask", - "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 gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" - }, - { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the group ID of the virtual machine", - "name": "groupid", - "type": "string" - }, - { - "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", - "type": "string" - }, - {}, - { - "description": "ssh key-pair", - "name": "keypair", + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", "type": "string" }, { - "description": "State of the Service from LB rule", - "name": "servicestate", + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", "type": "string" }, { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" - }, - { - "description": "the user's name who deployed the virtual machine", - "name": "username", - "type": "string" + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" }, { - "description": "the memory used by the vm", - "name": "memorykbs", - "type": "long" + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", + "type": "string" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "ssh key-pairs", + "name": "keypairs", "type": "string" }, { - "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", + "type": "string" }, { - "description": "the memory allocated for the virtual machine", - "name": "memory", + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", "type": "integer" }, { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, + { + "description": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" + }, { "description": "device type of the root volume", "name": "rootdevicetype", "type": "string" }, { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", + "description": "the password (if exists) of the virtual machine", + "name": "password", "type": "string" }, { - "description": "the name of the disk offering of the virtual machine", - "name": "diskofferingname", + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", + "type": "string" }, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", "type": "string" }, { - "description": "the number of cpu this virtual machine is running with", - "name": "cpunumber", - "type": "integer" + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" } ], "since": "4.2.0" @@ -68874,33 +70525,33 @@ "type": "integer" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "pagesize", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" } ], "related": "", "response": [ - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "the ID of the host tag", "name": "id", "type": "string" }, {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "the name of the host tag", "name": "name", @@ -68931,14 +70582,6 @@ "required": true, "type": "map" }, - { - "description": "ID of Guest OS category", - "length": 255, - "name": "oscategoryid", - "related": "listOsCategories", - "required": true, - "type": "uuid" - }, { "description": "Optional name for Guest OS", "length": 255, @@ -68952,29 +70595,28 @@ "name": "osdisplayname", "required": true, "type": "string" + }, + { + "description": "ID of Guest OS category", + "length": 255, + "name": "oscategoryid", + "related": "listOsCategories", + "required": true, + "type": "uuid" } ], "related": "", "response": [ - { - "description": "is the guest OS user defined", - "name": "isuserdefined", - "type": "boolean" - }, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, + {}, + {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the ID of the OS type", - "name": "id", + "description": "the ID of the OS category", + "name": "oscategoryid", "type": "string" }, { @@ -68982,10 +70624,19 @@ "name": "description", "type": "string" }, - {}, { - "description": "the ID of the OS category", - "name": "oscategoryid", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "is the guest OS user defined", + "name": "isuserdefined", + "type": "boolean" + }, + { + "description": "the ID of the OS type", + "name": "id", "type": "string" } ], @@ -69005,23 +70656,23 @@ "type": "boolean" }, { - "description": "the id of the entity to annotate", + "description": "the annotation text", "length": 255, - "name": "entityid", + "name": "annotation", "required": false, "type": "string" }, { - "description": "the entity type (only HOST is allowed atm)", + "description": "the id of the entity to annotate", "length": 255, - "name": "entitytype", + "name": "entityid", "required": false, "type": "string" }, { - "description": "the annotation text", + "description": "the entity type (only HOST is allowed atm)", "length": 255, - "name": "annotation", + "name": "entitytype", "required": false, "type": "string" } @@ -69034,24 +70685,19 @@ "type": "string" }, { - "description": "The (uu)id of the user that entered the annotation", - "name": "userid", - "type": "string" - }, - { - "description": "the name of the entitiy to which this annotation pertains", - "name": "entityname", + "description": "The username of the user that entered the annotation", + "name": "username", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the (uu)id of the annotation", + "name": "id", "type": "string" }, { - "description": "the type of the annotated entity", - "name": "entitytype", - "type": "string" + "description": "the creation timestamp for this annotation", + "name": "created", + "type": "date" }, { "description": "True if the annotation is available for admins only", @@ -69059,37 +70705,42 @@ "type": "boolean" }, { - "description": "the contents of the annotation", - "name": "annotation", + "description": "The (uu)id of the user that entered the annotation", + "name": "userid", "type": "string" }, - { - "description": "the removal timestamp for this annotation", - "name": "removed", - "type": "date" - }, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the creation timestamp for this annotation", - "name": "created", - "type": "date" + "description": "the contents of the annotation", + "name": "annotation", + "type": "string" }, { - "description": "The username of the user that entered the annotation", - "name": "username", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the (uu)id of the annotation", - "name": "id", + "description": "the type of the annotated entity", + "name": "entitytype", "type": "string" }, - {} + {}, + { + "description": "the name of the entitiy to which this annotation pertains", + "name": "entityname", + "type": "string" + }, + {}, + { + "description": "the removal timestamp for this annotation", + "name": "removed", + "type": "date" + } ], "since": "4.11" }, @@ -69108,28 +70759,28 @@ } ], "response": [ - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" }, - {} + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } ], "since": "4.4.0" }, @@ -69139,23 +70790,38 @@ "name": "registerIso", "params": [ { - "description": "the checksum value of this ISO. The parameter containing the checksum will be considered a MD5sum if it is not prefixed\n and just a plain ascii/utf8 representation of a hexadecimal string. If it is required to\n use another algorithm the hexadecimal string is to be prefixed with a string of the form,\n \"{}\", not including the double quotes. In this is the exact string\n representing the java supported algorithm, i.e. MD5 or SHA-256. Note that java does not\n contain an algorithm called SHA256 or one called sha-256, only SHA-256.", + "description": "the name of the ISO", "length": 255, - "name": "checksum", + "name": "name", + "required": true, + "type": "string" + }, + { + "description": "Image store UUID", + "length": 255, + "name": "imagestoreuuid", "required": false, "type": "string" }, { - "description": "true if this ISO is bootable. If not passed explicitly its assumed to be true", + "description": "Register ISO for the project", "length": 255, - "name": "bootable", + "name": "projectid", + "related": "listProjectAccounts,activateProject,suspendProject,updateProject", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "true if you want this ISO to be featured", + "description": "an optional account name. Must be used with domainId.", "length": 255, - "name": "isfeatured", + "name": "account", + "required": false, + "type": "string" + }, + { + "description": "true if password reset feature is supported; default is false", + "length": 255, + "name": "passwordenabled", "required": false, "type": "boolean" }, @@ -69168,37 +70834,37 @@ "type": "uuid" }, { - "description": "the URL to where the ISO is currently being hosted", - "length": 2048, - "name": "url", + "description": "the display text of the ISO. This is usually used for display purposes.", + "length": 4096, + "name": "displaytext", "required": true, "type": "string" }, { - "description": "the name of the ISO", + "description": "true if ISO should bypass Secondary Storage and be downloaded to Primary Storage on deployment", "length": 255, - "name": "name", - "required": true, - "type": "string" + "name": "directdownload", + "required": false, + "type": "boolean" }, { - "description": "true if ISO should bypass Secondary Storage and be downloaded to Primary Storage on deployment", + "description": "true if ISO contains XS/VMWare tools inorder to support dynamic scaling of VM CPU/memory", "length": 255, - "name": "directdownload", + "name": "isdynamicallyscalable", "required": false, "type": "boolean" }, { - "description": "true if password reset feature is supported; default is false", + "description": "true if this ISO is bootable. If not passed explicitly its assumed to be true", "length": 255, - "name": "passwordenabled", + "name": "bootable", "required": false, "type": "boolean" }, { - "description": "true if you want to register the ISO to be publicly available to all users, false otherwise.", + "description": "true if you want this ISO to be featured", "length": 255, - "name": "ispublic", + "name": "isfeatured", "required": false, "type": "boolean" }, @@ -69211,55 +70877,40 @@ "type": "uuid" }, { - "description": "true if the ISO or its derivatives are extractable; default is false", - "length": 255, - "name": "isextractable", - "required": false, - "type": "boolean" - }, - { - "description": "the ID of the OS type that best represents the OS of this ISO. If the ISO is bootable this parameter needs to be passed", + "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": "ostypeid", - "related": "", + "name": "checksum", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "an optional account name. Must be used with domainId.", - "length": 255, - "name": "account", - "required": false, + "description": "the URL to where the ISO is currently being hosted", + "length": 2048, + "name": "url", + "required": true, "type": "string" }, { - "description": "Register ISO for the project", + "description": "the ID of the OS type that best represents the OS of this ISO. If the ISO is bootable this parameter needs to be passed", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,suspendProject,updateProject", + "name": "ostypeid", + "related": "", "required": false, "type": "uuid" }, { - "description": "the display text of the ISO. This is usually used for display purposes.", - "length": 4096, - "name": "displaytext", - "required": true, - "type": "string" - }, - { - "description": "true if ISO contains XS/VMWare tools inorder to support dynamic scaling of VM CPU/memory", + "description": "true if the ISO or its derivatives are extractable; default is false", "length": 255, - "name": "isdynamicallyscalable", + "name": "isextractable", "required": false, "type": "boolean" }, { - "description": "Image store UUID", + "description": "true if you want to register the ISO to be publicly available to all users, false otherwise.", "length": 255, - "name": "imagestoreuuid", + "name": "ispublic", "required": false, - "type": "string" + "type": "boolean" } ], "related": "listIsos,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", @@ -69270,115 +70921,151 @@ "type": "string" }, { - "description": "true if the reset password feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" + "description": "checksum of the template", + "name": "checksum", + "type": "string" }, { - "description": "the ID of the OS type for this template.", - "name": "ostypeid", + "description": "the project name of the template", + "name": "project", "type": "string" }, { - "description": "true if the template is managed across all Zones, false otherwise", - "name": "crossZones", - "type": "boolean" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the status of the template", + "name": "status", + "type": "string" + }, + { + "description": "the size of the template", + "name": "size", + "type": "long" }, + {}, { "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 the template is managed across all Zones, false otherwise", + "name": "crossZones", + "type": "boolean" }, { - "description": "the date this template was created", - "name": "created", + "description": "the date this template was removed", + "name": "removed", "type": "date" }, { - "description": "the ID of the zone for this template", - "name": "zoneid", + "description": "the physical size of the template", + "name": "physicalsize", + "type": "long" + }, + { + "description": "the account id to which the template belongs", + "name": "accountid", "type": "string" }, { - "description": "true if this template is a featured template, false otherwise", - "name": "isfeatured", - "type": "boolean" + "description": "additional key/value details tied with template", + "name": "details", + "type": "map" }, { - "description": "true if the template is extractable, false otherwise", - "name": "isextractable", + "description": "the name of the OS type for this template.", + "name": "ostypename", + "type": "string" + }, + { + "description": "the template name", + "name": "name", + "type": "string" + }, + { + "description": "the template ID of the parent template if present", + "name": "sourcetemplateid", + "type": "string" + }, + { + "description": "VMware only: true if template is deployed without orchestrating disks and networks but \"as-is\" defined in the template.", + "name": "deployasis", "type": "boolean" }, { - "description": "if root disk template, then ids of the datas disk templates this template owns", - "name": "childtemplates", - "type": "set" + "description": "the processor bit size", + "name": "bits", + "type": "int" }, { - "description": "the account id to which the template belongs", - "name": "accountid", + "description": "the ID of the domain to which the template belongs", + "name": "domainid", "type": "string" }, { - "description": "VMware only: additional key/value details tied with deploy-as-is template", - "name": "deployasisdetails", - "type": "map" + "description": "the format of the template.", + "name": "format", + "type": "imageformat" }, { - "description": "true if template is sshkey enabled, false otherwise", - "name": "sshkeyenabled", + "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", + "name": "isdynamicallyscalable", "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "true if the template is extractable, false otherwise", + "name": "isextractable", + "type": "boolean" }, { - "description": "the name of the secondary storage host for the template", - "name": "hostname", + "description": "the ID of the OS type for this template.", + "name": "ostypeid", "type": "string" }, { - "description": "the URL which the template/iso is registered from", - "name": "url", - "type": "string" + "description": "Lists the download progress of a template across all secondary storages", + "name": "downloaddetails", + "type": "list" }, { - "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": "the template ID", - "name": "id", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the ID of the domain to which the template belongs", - "name": "domainid", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the template display text", + "name": "displaytext", "type": "string" }, { - "description": "the name of the OS type for this template.", - "name": "ostypename", + "description": "VMware only: additional key/value details tied with deploy-as-is template", + "name": "deployasisdetails", + "type": "map" + }, + { + "description": "the ID of the zone for this template", + "name": "zoneid", "type": "string" }, + { + "description": "true if the template is ready to be deployed from, false otherwise.", + "name": "isready", + "type": "boolean" + }, { "description": "the list of resource tags associated", "name": "tags", @@ -69389,23 +71076,18 @@ "type": "string" }, { - "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": "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 ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { @@ -69414,13 +71096,8 @@ "type": "string" }, { - "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" }, { @@ -69432,44 +71109,44 @@ "description": "the domain associated with the tag", "name": "domain", "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" } ], "type": "set" }, { - "description": "the status of the template", - "name": "status", - "type": "string" - }, - { - "description": "the project id of the template", - "name": "projectid", - "type": "string" - }, - { - "description": "the template display text", - "name": "displaytext", + "description": "the account name to which the template belongs", + "name": "account", "type": "string" }, { - "description": "checksum of the template", - "name": "checksum", - "type": "string" + "description": "the date this template was created", + "name": "created", + "type": "date" }, { - "description": "the template ID of the parent template if present", - "name": "sourcetemplateid", + "description": "the tag of this template", + "name": "templatetag", "type": "string" }, { - "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", - "name": "isdynamicallyscalable", + "description": "true if the reset password feature is enabled, false otherwise", + "name": "passwordenabled", "type": "boolean" }, { - "description": "the template name", - "name": "name", - "type": "string" + "description": "true if the ISO is bootable, false otherwise", + "name": "bootable", + "type": "boolean" }, { "description": "true if this template is a public template, false otherwise", @@ -69478,30 +71155,24 @@ }, {}, { - "description": "VMware only: true if template is deployed without orchestrating disks and networks but \"as-is\" defined in the template.", - "name": "deployasis", - "type": "boolean" - }, - { - "description": "the project name of the template", - "name": "project", + "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": "the project id of the template", + "name": "projectid", + "type": "string" }, - {}, { - "description": "true if the ISO is bootable, false otherwise", - "name": "bootable", + "description": "true if template is sshkey enabled, false otherwise", + "name": "sshkeyenabled", "type": "boolean" }, { - "description": "the processor bit size", - "name": "bits", - "type": "int" + "description": "true if this template is a featured template, false otherwise", + "name": "isfeatured", + "type": "boolean" }, { "description": "the type of the template", @@ -69509,24 +71180,14 @@ "type": "string" }, { - "description": "true if template requires HVM enabled, false otherwise", - "name": "requireshvm", - "type": "boolean" - }, - { - "description": "the physical size of the template", - "name": "physicalsize", - "type": "long" - }, - { - "description": "Lists the download progress of a template across all secondary storages", - "name": "downloaddetails", - "type": "list" + "description": "the name of the secondary storage host for the template", + "name": "hostname", + "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" }, { "description": "the ID of the secondary storage host for the template", @@ -69534,39 +71195,29 @@ "type": "string" }, { - "description": "true if the template is ready to be deployed from, false otherwise.", - "name": "isready", - "type": "boolean" - }, - { - "description": "the name of the domain to which the template belongs", - "name": "domain", + "description": "the name of the zone for this template", + "name": "zonename", "type": "string" }, { - "description": "the tag of this template", - "name": "templatetag", + "description": "the template ID", + "name": "id", "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 account name to which the template belongs", - "name": "account", + "description": "the URL which the template/iso is registered from", + "name": "url", "type": "string" }, { - "description": "the date this template was removed", - "name": "removed", - "type": "date" - }, - { - "description": "additional key/value details tied with template", - "name": "details", - "type": "map" + "description": "if root disk template, then ids of the datas disk templates this template owns", + "name": "childtemplates", + "type": "set" } ] }, @@ -69576,19 +71227,11 @@ "name": "listCiscoAsa1000vResources", "params": [ { - "description": "Cisco ASA 1000v resource ID", - "length": 255, - "name": "resourceid", - "related": "addCiscoAsa1000vResource,listCiscoAsa1000vResources", - "required": false, - "type": "uuid" - }, - { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { "description": "Hostname or ip address of the Cisco ASA 1000v appliance.", @@ -69598,36 +71241,38 @@ "type": "string" }, { - "description": "the Physical Network ID", + "description": "Cisco ASA 1000v resource ID", "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork", + "name": "resourceid", + "related": "addCiscoAsa1000vResource,listCiscoAsa1000vResources", "required": false, "type": "uuid" }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, { - "description": "", + "description": "the Physical Network ID", "length": 255, - "name": "pagesize", + "name": "physicalnetworkid", + "related": "createPhysicalNetwork", "required": false, - "type": "integer" + "type": "uuid" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" } ], "related": "addCiscoAsa1000vResource", "response": [ - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - {}, {}, {}, { @@ -69637,6 +71282,12 @@ }, {}, {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {}, {}, {} ] @@ -69647,74 +71298,58 @@ "name": "deployNetscalerVpx", "params": [ { - "description": "the ID of the template for the virtual machine", + "description": "the ID of the service offering for the virtual machine", "length": 255, - "name": "templateid", - "related": "listIsos,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", + "name": "serviceofferingid", + "related": "updateServiceOffering,listServiceOfferings", "required": true, "type": "uuid" }, { - "description": "The network this ip address should be associated to.", + "description": "availability zone for the virtual machine", "length": 255, - "name": "networkid", - "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listF5LoadBalancerNetworks,listNetscalerLoadBalancerNetworks,listBrocadeVcsDeviceNetworks", - "required": false, + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": true, "type": "uuid" }, { - "description": "the ID of the service offering for the virtual machine", + "description": "the ID of the template for the virtual machine", "length": 255, - "name": "serviceofferingid", - "related": "updateServiceOffering,listServiceOfferings", + "name": "templateid", + "related": "listIsos,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", "required": true, "type": "uuid" }, { - "description": "availability zone for the virtual machine", + "description": "The network this ip address should be associated to.", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": true, + "name": "networkid", + "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listBrocadeVcsDeviceNetworks", + "required": false, "type": "uuid" } ], "related": "addNetscalerLoadBalancer,listNetscalerLoadBalancers,registerNetscalerControlCenter", "response": [ { - "description": "device id of the netscaler load balancer", - "name": "lbdeviceid", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the physical network to which this netscaler device belongs to", - "name": "physicalnetworkid", + "description": "device name", + "name": "lbdevicename", "type": "string" }, - { - "description": "true if NetScaler device is provisioned exclusively to be a GSLB service provider", - "name": "isexclusivegslbprovider", - "type": "boolean" - }, { "description": "the management IP address of the external load balancer", "name": "ipaddress", "type": "string" }, { - "description": "public IP of the NetScaler representing GSLB site", - "name": "gslbproviderpublicip", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, - {}, { - "description": "name of the provider", - "name": "provider", + "description": "the public interface of the load balancer", + "name": "publicinterface", "type": "string" }, { @@ -69723,19 +71358,19 @@ "type": "string" }, { - "description": "the private interface of the load balancer", - "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": "device id of the netscaler load balancer", + "name": "lbdeviceid", "type": "string" }, { - "description": "true if device is dedicated for an account", - "name": "lbdevicededicated", - "type": "boolean" + "description": "Used when NetScaler device is provider of EIP service. This parameter represents the list of pod's, for which there exists a policy based route on datacenter L3 router to route pod's subnet IP to a NetScaler device.", + "name": "podids", + "type": "list" }, { "description": "private IP of the NetScaler representing GSLB site", @@ -69743,8 +71378,8 @@ "type": "string" }, { - "description": "device name", - "name": "lbdevicename", + "description": "the physical network to which this netscaler device belongs to", + "name": "physicalnetworkid", "type": "string" }, { @@ -69752,22 +71387,38 @@ "name": "gslbprovider", "type": "boolean" }, + {}, { - "description": "Used when NetScaler device is provider of EIP service. This parameter represents the list of pod's, for which there exists a policy based route on datacenter L3 router to route pod's subnet IP to a NetScaler device.", - "name": "podids", - "type": "list" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "true if NetScaler device is provisioned exclusively to be a GSLB service provider", + "name": "isexclusivegslbprovider", + "type": "boolean" + }, + { + "description": "true if device is dedicated for an account", + "name": "lbdevicededicated", + "type": "boolean" }, - {}, { "description": "device capacity", "name": "lbdevicecapacity", "type": "long" }, { - "description": "the public interface of the load balancer", - "name": "publicinterface", + "description": "public IP of the NetScaler representing GSLB site", + "name": "gslbproviderpublicip", "type": "string" - } + }, + { + "description": "the private interface of the load balancer", + "name": "privateinterface", + "type": "string" + }, + {} ] }, { @@ -69791,15 +71442,8 @@ "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - {}, - {}, - { - "description": "syncronization", - "name": "sync", + "description": "compression", + "name": "compression", "type": "string" }, { @@ -69807,24 +71451,31 @@ "name": "deduplication", "type": "string" }, + {}, + { + "description": "the id of the volume", + "name": "id", + "type": "string" + }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "graceallowed", - "name": "graceallowed", + "description": "syncronization", + "name": "sync", "type": "string" }, { - "description": "compression", - "name": "compression", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, { - "description": "the id of the volume", - "name": "id", + "description": "graceallowed", + "name": "graceallowed", "type": "string" } ] @@ -69856,15 +71507,15 @@ }, {}, {}, - { - "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" } ] }, @@ -69874,9 +71525,9 @@ "name": "addBaremetalPxeKickStartServer", "params": [ { - "description": "type of pxe device", + "description": "Tftp root directory of PXE server", "length": 255, - "name": "pxeservertype", + "name": "tftpdir", "required": true, "type": "string" }, @@ -69896,17 +71547,9 @@ "type": "uuid" }, { - "description": "the Physical Network ID", - "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork", - "required": true, - "type": "uuid" - }, - { - "description": "Tftp root directory of PXE server", + "description": "type of pxe device", "length": 255, - "name": "tftpdir", + "name": "pxeservertype", "required": true, "type": "string" }, @@ -69923,34 +71566,32 @@ "name": "url", "required": true, "type": "string" + }, + { + "description": "the Physical Network ID", + "length": 255, + "name": "physicalnetworkid", + "related": "createPhysicalNetwork", + "required": true, + "type": "uuid" } ], "related": "", "response": [ + {}, { - "description": "device id of ", - "name": "id", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "name of the provider", + "name": "provider", "type": "string" }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - {}, { "description": "the physical network to which this external dhcp device belongs to", "name": "physicalnetworkid", "type": "string" }, { - "description": "name of the provider", - "name": "provider", + "description": "device id of ", + "name": "id", "type": "string" }, { @@ -69958,12 +71599,22 @@ "name": "tftpdir", "type": "string" }, + {}, { "description": "url", "name": "url", "type": "string" }, - {} + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + } ] }, { @@ -69972,12 +71623,11 @@ "name": "listNiciraNvpDevices", "params": [ { - "description": "nicira nvp device ID", + "description": "List by keyword", "length": 255, - "name": "nvpdeviceid", - "related": "addNiciraNvpDevice,listNiciraNvpDevices", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" }, { "description": "", @@ -69987,18 +71637,12 @@ "type": "integer" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - }, - { - "description": "", + "description": "nicira nvp device ID", "length": 255, - "name": "page", + "name": "nvpdeviceid", + "related": "addNiciraNvpDevice,listNiciraNvpDevices", "required": false, - "type": "integer" + "type": "uuid" }, { "description": "the Physical Network ID", @@ -70007,33 +71651,31 @@ "related": "createPhysicalNetwork", "required": false, "type": "uuid" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" } ], "related": "addNiciraNvpDevice", "response": [ { - "description": "device id of the Nicire Nvp", - "name": "nvpdeviceid", - "type": "string" - }, - { - "description": "the physical network to which this Nirica Nvp belongs to", - "name": "physicalnetworkid", - "type": "string" - }, - { - "description": "the controller Ip address", - "name": "hostname", + "description": "the transport zone Uuid", + "name": "transportzoneuuid", "type": "string" }, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "this L3 gateway service Uuid", + "name": "l3gatewayserviceuuid", "type": "string" }, { - "description": "this L2 gateway service Uuid", - "name": "l2gatewayserviceuuid", + "description": "the physical network to which this Nirica Nvp belongs to", + "name": "physicalnetworkid", "type": "string" }, { @@ -70041,7 +71683,6 @@ "name": "provider", "type": "string" }, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", @@ -70053,16 +71694,26 @@ "type": "string" }, { - "description": "this L3 gateway service Uuid", - "name": "l3gatewayserviceuuid", + "description": "the controller Ip address", + "name": "hostname", "type": "string" }, { - "description": "the transport zone Uuid", - "name": "transportzoneuuid", + "description": "device id of the Nicire Nvp", + "name": "nvpdeviceid", "type": "string" }, - {} + {}, + { + "description": "this L2 gateway service Uuid", + "name": "l2gatewayserviceuuid", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + } ] }, { @@ -70071,19 +71722,18 @@ "name": "listAlerts", "params": [ { - "description": "the ID of the alert", + "description": "list by alert type", "length": 255, - "name": "id", - "related": "listAlerts", + "name": "type", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "list by alert type", + "description": "", "length": 255, - "name": "type", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { "description": "List by keyword", @@ -70093,11 +71743,12 @@ "type": "string" }, { - "description": "", + "description": "the ID of the alert", "length": 255, - "name": "pagesize", + "name": "id", + "related": "listAlerts", "required": false, - "type": "integer" + "type": "uuid" }, { "description": "", @@ -70123,16 +71774,21 @@ "type": "date" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "description of the alert", + "name": "description", "type": "string" }, - {}, { - "description": "description of the alert", - "name": "description", + "description": "the name of the alert", + "name": "name", "type": "string" }, + { + "description": "One of the following alert types: MEMORY = 0, CPU = 1, STORAGE = 2, STORAGE_ALLOCATED = 3, PUBLIC_IP = 4, PRIVATE_IP = 5, SECONDARY_STORAGE = 6, HOST = 7, USERVM = 8, DOMAIN_ROUTER = 9, CONSOLE_PROXY = 10, ROUTING = 11: lost connection to default route (to the gateway), STORAGE_MISC = 12, USAGE_SERVER = 13, MANAGMENT_NODE = 14, DOMAIN_ROUTER_MIGRATE = 15, CONSOLE_PROXY_MIGRATE = 16, USERVM_MIGRATE = 17, VLAN = 18, SSVM = 19, USAGE_SERVER_RESULT = 20, STORAGE_DELETE = 21, UPDATE_RESOURCE_COUNT = 22, USAGE_SANITY_RESULT = 23, DIRECT_ATTACHED_PUBLIC_IP = 24, LOCAL_STORAGE = 25, RESOURCE_LIMIT_EXCEEDED = 26, SYNC = 27, UPLOAD_FAILED = 28, OOBM_AUTH_ERROR = 29", + "name": "type", + "type": "short" + }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", @@ -70143,15 +71799,10 @@ "name": "id", "type": "string" }, - { - "description": "One of the following alert types: MEMORY = 0, CPU = 1, STORAGE = 2, STORAGE_ALLOCATED = 3, PUBLIC_IP = 4, PRIVATE_IP = 5, SECONDARY_STORAGE = 6, HOST = 7, USERVM = 8, DOMAIN_ROUTER = 9, CONSOLE_PROXY = 10, ROUTING = 11: lost connection to default route (to the gateway), STORAGE_MISC = 12, USAGE_SERVER = 13, MANAGMENT_NODE = 14, DOMAIN_ROUTER_MIGRATE = 15, CONSOLE_PROXY_MIGRATE = 16, USERVM_MIGRATE = 17, VLAN = 18, SSVM = 19, USAGE_SERVER_RESULT = 20, STORAGE_DELETE = 21, UPDATE_RESOURCE_COUNT = 22, USAGE_SANITY_RESULT = 23, DIRECT_ATTACHED_PUBLIC_IP = 24, LOCAL_STORAGE = 25, RESOURCE_LIMIT_EXCEEDED = 26, SYNC = 27, UPLOAD_FAILED = 28, OOBM_AUTH_ERROR = 29", - "name": "type", - "type": "short" - }, {}, { - "description": "the name of the alert", - "name": "name", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" } ] @@ -70162,70 +71813,97 @@ "name": "deployVirtualMachine", "params": [ { - "description": "the ipv6 address for default vm's network", + "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": "ip6address", + "name": "boottype", "required": false, + "since": "4.14.0.0", "type": "string" }, { - "description": "the arbitrary size for the DATADISK volume. Mutually exclusive with diskOfferingId", + "description": "list of network ids used by virtual machine. Can't be specified with ipToNetworkList parameter", "length": 255, - "name": "size", + "name": "networkids", + "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listBrocadeVcsDeviceNetworks", "required": false, - "type": "long" + "type": "list" }, { - "description": "true if virtual machine needs to be dynamically scalable", + "description": "destination Cluster ID to deploy the VM to - parameter available for root admin only", "length": 255, - "name": "dynamicscalingenabled", + "name": "clusterid", + "related": "addCluster", "required": false, - "since": "4.16", - "type": "boolean" + "since": "4.13", + "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 ipv6 address for default vm's network", "length": 255, - "name": "datadiskofferinglist", + "name": "ip6address", + "required": false, + "type": "string" + }, + { + "description": "ip to network mapping. Can't be specified with networkIds parameter. Example: iptonetworklist[0].ip=10.10.10.11&iptonetworklist[0].ipv6=fc00:1234:5678::abcd&iptonetworklist[0].networkid=uuid&iptonetworklist[0].mac=aa:bb:cc:dd:ee::ff - requests to use ip 10.10.10.11 in network id=uuid", + "length": 255, + "name": "iptonetworklist", "required": false, - "since": "4.11", "type": "map" }, { - "description": "an optional group for the virtual machine", + "description": "comma separated list of affinity groups names that are going to be applied to the virtual machine.Mutually exclusive with affinitygroupids parameter", "length": 255, - "name": "group", + "name": "affinitygroupnames", + "related": "", "required": false, - "type": "string" + "type": "list" }, { - "description": "host name for the virtual machine", + "description": "an optional user generated name for the virtual machine", "length": 255, - "name": "name", + "name": "displayname", "required": false, "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": "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": "used to specify the vApp properties.", + "length": 255, + "name": "properties", + "required": false, + "since": "4.15", + "type": "map" + }, + { + "description": "the mac address for default vm's network", "length": 255, - "name": "rootdisksize", + "name": "macaddress", "required": false, - "since": "4.4", - "type": "long" + "type": "string" }, { - "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", + "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": "customid", + "name": "securitygroupnames", + "related": "createSecurityGroup", "required": false, - "type": "string" + "type": "list" }, { - "description": "DHCP options which are passed to the VM on start up Example: dhcpoptionsnetworklist[0].dhcp:114=url&dhcpoptionsetworklist[0].networkid=networkid&dhcpoptionsetworklist[0].dhcp:66=www.test.com", + "description": "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": "dhcpoptionsnetworklist", + "name": "diskofferingid", + "related": "createDiskOffering", "required": false, - "type": "map" + "type": "uuid" }, { "description": "an optional binary data that can be sent to the virtual machine upon a successful deployment. This binary data must be base64 encoded before adding it to the request. Using HTTP GET (via querystring), you can send up to 4KB of data after base64 encoding. Using HTTP POST(via POST body), you can send up to 1MB of data after base64 encoding.", @@ -70235,106 +71913,104 @@ "type": "string" }, { - "description": "used to specify the custom parameters. 'extraconfig' is not allowed to be passed in details", - "length": 255, - "name": "details", + "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.3", - "type": "map" + "since": "4.12", + "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", + "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": "nicnetworklist", + "name": "affinitygroupids", + "related": "", "required": false, - "since": "4.15", - "type": "map" + "type": "list" }, { - "description": "used to specify the vApp properties.", + "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": "properties", + "name": "datadiskofferinglist", "required": false, - "since": "4.15", + "since": "4.11", "type": "map" }, { - "description": "an optional URL encoded string that can be passed to the virtual machine upon successful deployment", - "length": 5120, - "name": "extraconfig", + "description": "Deploy vm for the project", + "length": 255, + "name": "projectid", + "related": "listProjectAccounts,activateProject,suspendProject,updateProject", "required": false, - "since": "4.12", - "type": "string" + "type": "uuid" }, { - "description": "true if start vm after creating; defaulted to true if not specified", + "description": "Boot into hardware setup or not (ignored if startVm = false, only valid for vmware)", "length": 255, - "name": "startvm", + "name": "bootintosetup", "required": false, + "since": "4.15.0.0", "type": "boolean" }, { - "description": "the hypervisor on which to deploy the virtual machine. The parameter is required and respected only when hypervisor info is not set on the ISO/Template passed to the call", + "description": "the ip address for default vm's network", "length": 255, - "name": "hypervisor", + "name": "ipaddress", "required": false, "type": "string" }, { - "description": "destination Pod ID to deploy the VM to - parameter available for root admin only", + "description": "DHCP options which are passed to the VM on start up Example: dhcpoptionsnetworklist[0].dhcp:114=url&dhcpoptionsetworklist[0].networkid=networkid&dhcpoptionsetworklist[0].dhcp:66=www.test.com", "length": 255, - "name": "podid", - "related": "updatePod,createManagementNetworkIpRange", + "name": "dhcpoptionsnetworklist", "required": false, - "since": "4.13", - "type": "uuid" + "type": "map" }, { - "description": "comma separated list of security groups names that going to be applied to the virtual machine. Should be passed only when vm is created from a zone with Basic Network support. Mutually exclusive with securitygroupids parameter", + "description": "an optional account for the virtual machine. Must be used with domainId.", "length": 255, - "name": "securitygroupnames", - "related": "createSecurityGroup", + "name": "account", "required": false, - "type": "list" + "type": "string" }, { - "description": "an optional field, whether to the display the vm to the end user or not.", + "description": "true if start vm after creating; defaulted to true if not specified", "length": 255, - "name": "displayvm", + "name": "startvm", "required": false, - "since": "4.2", "type": "boolean" }, { - "description": "list of network ids used by virtual machine. Can't be specified with ipToNetworkList parameter", + "description": "Optional field to resize root disk on deploy. Value is in GB. Only applies to template-based deployments. Analogous to details[0].rootdisksize, which takes precedence over this parameter if both are provided", "length": 255, - "name": "networkids", - "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listF5LoadBalancerNetworks,listNetscalerLoadBalancerNetworks,listBrocadeVcsDeviceNetworks", + "name": "rootdisksize", "required": false, - "type": "list" + "since": "4.4", + "type": "long" }, { - "description": "the ID of the service offering for the virtual machine", + "description": "VMware only: used to specify network mapping of a vApp VMware template registered \"as-is\". Example nicnetworklist[0].ip=Nic-101&nicnetworklist[0].network=uuid", "length": 255, - "name": "serviceofferingid", - "related": "updateServiceOffering,listServiceOfferings", - "required": true, - "type": "uuid" + "name": "nicnetworklist", + "required": false, + "since": "4.15", + "type": "map" }, { - "description": "Guest VM Boot option either custom[UEFI] or default boot [BIOS]. Not applicable with VMware, as we honour what is defined in the template.", + "description": "availability zone for the virtual machine", "length": 255, - "name": "boottype", - "required": false, - "since": "4.14.0.0", - "type": "string" + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": true, + "type": "uuid" }, { - "description": "the ip address for default vm's network", + "description": "if true the image tags (if any) will be copied to the VM, default value is false", "length": 255, - "name": "ipaddress", + "name": "copyimagetags", "required": false, - "type": "string" + "since": "4.13", + "type": "boolean" }, { "description": "name of the ssh key pair used to login to the virtual machine", @@ -70344,27 +72020,25 @@ "type": "string" }, { - "description": "ip to network mapping. Can't be specified with networkIds parameter. Example: iptonetworklist[0].ip=10.10.10.11&iptonetworklist[0].ipv6=fc00:1234:5678::abcd&iptonetworklist[0].networkid=uuid&iptonetworklist[0].mac=aa:bb:cc:dd:ee::ff - requests to use ip 10.10.10.11 in network id=uuid", + "description": "host name for the virtual machine", "length": 255, - "name": "iptonetworklist", + "name": "name", "required": false, - "type": "map" + "type": "string" }, { - "description": "comma separated list of affinity groups names that are going to be applied to the virtual machine.Mutually exclusive with affinitygroupids parameter", + "description": "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": "affinitygroupnames", - "related": "", + "name": "keyboard", "required": false, - "type": "list" + "type": "string" }, { - "description": "comma separated list of affinity groups id that are going to be applied to the virtual machine. Mutually exclusive with affinitygroupnames parameter", + "description": "an optional group for the virtual machine", "length": 255, - "name": "affinitygroupids", - "related": "", + "name": "group", "required": false, - "type": "list" + "type": "string" }, { "description": "the ID of the template for the virtual machine", @@ -70375,19 +72049,13 @@ "type": "uuid" }, { - "description": "Boot Mode [Legacy] or [Secure] Applicable when Boot Type Selected is UEFI, otherwise Legacy only for BIOS. Not applicable with VMware, as we honour what is defined in the template.", - "length": 255, - "name": "bootmode", - "required": false, - "since": "4.14.0.0", - "type": "string" - }, - { - "description": "an optional account for the virtual machine. Must be used with domainId.", + "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": "account", + "name": "overridediskofferingid", + "related": "createDiskOffering", "required": false, - "type": "string" + "since": "4.17", + "type": "uuid" }, { "description": "an optional domainId for the virtual machine. If the account parameter is used, domainId must also be used.", @@ -70398,33 +72066,27 @@ "type": "uuid" }, { - "description": "Boot into hardware setup or not (ignored if startVm = false, only valid for vmware)", + "description": "used to specify the custom parameters. 'extraconfig' is not allowed to be passed in details", "length": 255, - "name": "bootintosetup", + "name": "details", "required": false, - "since": "4.15.0.0", - "type": "boolean" + "since": "4.3", + "type": "map" }, { - "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": "an optional field, whether to the display the vm to the end user or not.", "length": 255, - "name": "keyboard", + "name": "displayvm", "required": false, - "type": "string" + "since": "4.2", + "type": "boolean" }, { - "description": "the mac address for default vm's network", + "description": "destination Host ID to deploy the VM to - parameter available for root admin only", "length": 255, - "name": "macaddress", + "name": "hostid", + "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,reconnectHost", "required": false, - "type": "string" - }, - { - "description": "availability zone for the virtual machine", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": true, "type": "uuid" }, { @@ -70436,27 +72098,18 @@ "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": "Deploy vm for the project", + "description": "the arbitrary size for the DATADISK volume. Mutually exclusive with diskOfferingId", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,suspendProject,updateProject", + "name": "size", "required": false, - "type": "uuid" + "type": "long" }, { - "description": "the ID of the disk offering for the virtual machine. If the template is of ISO format, the diskOfferingId is for the root disk volume. Otherwise this parameter is used to indicate the offering for the data disk volume. If the templateId parameter passed is from a Template object, the diskOfferingId refers to a DATA Disk Volume created. If the templateId parameter passed is from an ISO object, the diskOfferingId refers to a ROOT Disk Volume created.", + "description": "the ID of the service offering for the virtual machine", "length": 255, - "name": "diskofferingid", - "related": "createDiskOffering", - "required": false, + "name": "serviceofferingid", + "related": "updateServiceOffering,listServiceOfferings", + "required": true, "type": "uuid" }, { @@ -70468,398 +72121,94 @@ "type": "list" }, { - "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": "destination Cluster ID to deploy the VM to - parameter available for root admin only", + "description": "destination Pod ID to deploy the VM to - parameter available for root admin only", "length": 255, - "name": "clusterid", - "related": "addCluster", + "name": "podid", + "related": "updatePod,createManagementNetworkIpRange", "required": false, "since": "4.13", "type": "uuid" }, { - "description": "an optional user generated name for the virtual machine", + "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": "displayname", + "name": "hypervisor", "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", - "response": [ - { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", - "type": "string" - }, - { - "description": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" - }, - { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", - "type": "boolean" - }, - { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" - }, - { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", - "type": "string" - }, - { - "description": "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 read (io) of disk on the vm", - "name": "diskioread", - "type": "long" - }, - { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" - }, - { - "description": "the list of nics associated with vm", - "name": "nic", - "response": [ - { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "the isolation uri of the nic", - "name": "isolationuri", - "type": "string" - }, - { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - }, - { - "description": "the name of the corresponding network", - "name": "networkname", - "type": "string" - }, - { - "description": "the ID of the corresponding network", - "name": "networkid", - "type": "string" - }, - { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", - "type": "string" - }, - { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "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 gateway of the nic", - "name": "gateway", - "type": "string" - }, - { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", - "type": "string" - }, - { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" - }, - { - "description": "the netmask of the nic", - "name": "netmask", - "type": "string" - }, - { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", - "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 ip address of the nic", - "name": "ipaddress", - "type": "string" - }, - { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", - "type": "string" - }, - { - "description": "the ID of the nic", - "name": "id", - "type": "string" - }, - { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", - "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": "Type of adapter if available", - "name": "adaptertype", - "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 type of the nic", - "name": "type", - "type": "string" - } - ], - "type": "set" }, { - "description": "OS name of the vm", - "name": "osdisplayname", + "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": "true if high-availability is enabled, false otherwise", - "name": "haenable", + "description": "true if virtual machine needs to be dynamically scalable", + "length": 255, + "name": "dynamicscalingenabled", + "required": false, + "since": "4.16", "type": "boolean" }, { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", - "type": "string" - }, - { - "description": "Guest vm Boot Mode", + "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 hypervisor on which the template runs", - "name": "hypervisor", - "type": "string" - }, - { - "description": "the group ID of the virtual machine", - "name": "groupid", - "type": "string" - }, - { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", - "type": "string" - }, - { - "description": "the pool type of the virtual machine", - "name": "pooltype", - "type": "string" - }, + } + ], + "related": "migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,destroyVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance", + "response": [ { - "description": "OS type id of the vm", - "name": "ostypeid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the group name of the virtual machine", - "name": "group", - "type": "string" + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" }, { - "description": "the read (bytes) of disk on the vm", + "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": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", - "type": "string" - }, - { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", - "type": "string" - }, - { - "description": "the password (if exists) of the virtual machine", - "name": "password", - "type": "string" - }, - { - "description": "the name of the disk offering of the virtual machine", - "name": "diskofferingname", + "description": "OS name of the vm", + "name": "osdisplayname", "type": "string" }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, { "description": "list of security groups associated with the virtual machine", "name": "securitygroup", "response": [ { - "description": "the 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 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", + "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 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 project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the list of ingress rules associated with the security group", - "name": "ingressrule", - "response": [ - { - "description": "account owning the security group rule", - "name": "account", - "type": "string" + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" }, { "description": "the protocol of the security group rule", @@ -70872,32 +72221,32 @@ "type": "string" }, { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", + "description": "the starting IP of the security group rule", + "name": "startport", "type": "integer" }, { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", + "description": "account owning the security group rule", + "name": "account", "type": "string" }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ + { + "description": "tag key name", + "name": "key", + "type": "string" + }, { "description": "the project name where tag belongs to", "name": "project", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "tag value", + "name": "value", "type": "string" }, { @@ -70906,8 +72255,8 @@ "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { @@ -70915,19 +72264,14 @@ "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", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { @@ -70936,34 +72280,39 @@ "type": "string" }, { - "description": "tag key name", - "name": "key", + "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 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 project name of the group", - "name": "project", + "description": "the domain ID of the security group", + "name": "domainid", + "type": "string" + }, + { + "description": "the account owning the security group", + "name": "account", + "type": "string" + }, + { + "description": "the domain name of the security group", + "name": "domain", "type": "string" }, { @@ -70975,28 +72324,48 @@ "description": "the list of egress rules associated with the security group", "name": "egressrule", "response": [ + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "the 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 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": "resource type", - "name": "resourcetype", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { @@ -71005,98 +72374,174 @@ "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "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": "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": "the account associated with the tag", - "name": "account", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" } ], "type": "set" }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, { "description": "the type of the ICMP message response", "name": "icmptype", "type": "integer" + } + ], + "type": "set" + }, + { + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" + }, + { + "description": "the project name of the group", + "name": "project", + "type": "string" + }, + { + "description": "the name of the security group", + "name": "name", + "type": "string" + }, + { + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" + }, + { + "description": "the 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 security group rule", - "name": "ruleid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "security group name", - "name": "securitygroupname", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" + "description": "tag key name", + "name": "key", + "type": "string" }, { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", + "description": "tag value", + "name": "value", "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": "the domain associated with the tag", + "name": "domain", + "type": "string" }, { - "description": "the protocol of the security group rule", - "name": "protocol", + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the 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 project id of the group", - "name": "projectid", - "type": "string" - }, - { - "description": "the name of the security group", - "name": "name", + "description": "the description of the security group", + "name": "description", "type": "string" } ], "type": "set" }, - {}, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", + "type": "string" + }, + { + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", + "type": "string" + }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", + "type": "string" + }, + { + "description": "the pool type of the virtual machine", + "name": "pooltype", + "type": "string" + }, + { + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", "type": "string" }, { @@ -71105,25 +72550,105 @@ "type": "string" }, { - "description": "the ID of the availablility zone for the virtual machine", - "name": "zoneid", + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" + }, + { + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" + }, + { + "description": "ssh key-pairs", + "name": "keypairs", "type": "string" }, - {}, - {}, { - "description": "the speed of each cpu", - "name": "cpuspeed", - "type": "integer" + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", + "type": "string" }, { - "description": "Guest vm Boot Type", - "name": "boottype", + "description": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", + "response": [ + { + "description": "the name of the affinity group", + "name": "name", + "type": "string" + }, + { + "description": "the type of the affinity group", + "name": "type", + "type": "string" + }, + { + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" + }, + { + "description": "the project ID of the affinity group", + "name": "projectid", + "type": "string" + }, + { + "description": "the ID of the affinity group", + "name": "id", + "type": "string" + }, + { + "description": "the domain ID of the affinity group", + "name": "domainid", + "type": "string" + }, + { + "description": "the account owning the affinity group", + "name": "account", + "type": "string" + }, + { + "description": "the project name of the affinity group", + "name": "project", + "type": "string" + }, + { + "description": "the description of the affinity group", + "name": "description", + "type": "string" + }, + { + "description": "the domain name of the affinity group", + "name": "domain", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the user's name who deployed the virtual machine", + "name": "username", "type": "string" }, { - "description": "ssh key-pair", - "name": "keypair", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", + "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": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", "type": "string" }, { @@ -71132,43 +72657,68 @@ "type": "string" }, { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", + "description": "the group name of the virtual machine", + "name": "group", "type": "string" }, { - "description": "the outgoing network traffic on the host", - "name": "networkkbswrite", + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", "type": "long" }, { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", + "description": "the name of the virtual machine", + "name": "name", "type": "string" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", + "description": "the password (if exists) of the virtual machine", + "name": "password", "type": "string" }, { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" + }, + { + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", "type": "string" }, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", + "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", + "type": "long" + }, + { + "description": "the memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" + }, + { + "description": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" + }, + { + "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": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", + "type": "string" + }, + { + "description": "the project name of the vm", + "name": "project", "type": "string" }, { @@ -71176,81 +72726,87 @@ "name": "tags", "response": [ { - "description": "the account associated with the tag", - "name": "account", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the 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 ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "tag key name", + "name": "key", "type": "string" } ], "type": "set" }, { - "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 UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the ID of the host for the virtual machine", + "name": "hostid", "type": "string" }, { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", - "type": "string" + "description": "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 ID of the availablility zone for the virtual machine", + "name": "zoneid", "type": "string" }, + {}, { - "description": "the ID of the disk offering of the virtual machine", - "name": "diskofferingid", + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" + }, + { + "description": "Os type ID of the virtual machine", + "name": "guestosid", "type": "string" }, { @@ -71259,166 +72815,287 @@ "type": "string" }, { - "description": "the account associated with the virtual machine", - "name": "account", + "description": "the name of the disk offering of the virtual machine", + "name": "diskofferingname", "type": "string" }, { - "description": "the name of the virtual machine", - "name": "name", - "type": "string" + "description": "the read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" }, { - "description": "the 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": "device type of the root volume", - "name": "rootdevicetype", - "type": "string" + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" }, { - "description": "the project id of the vm", - "name": "projectid", + "description": "the group ID of the virtual machine", + "name": "groupid", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", - "type": "string" + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" }, { - "description": "the number of cpu this virtual machine is running with", - "name": "cpunumber", + "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": "State of the Service from LB rule", - "name": "servicestate", + "description": "Guest vm Boot Mode", + "name": "bootmode", "type": "string" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "Guest vm Boot Type", + "name": "boottype", "type": "string" }, { - "description": "the incoming network traffic on the vm", - "name": "networkkbsread", - "type": "long" + "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": "publicipid", + "description": "the user's ID who deployed the virtual machine", + "name": "userid", "type": "string" }, { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" - }, - { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", - "type": "boolean" + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" }, { - "description": "the user's name who deployed the virtual machine", - "name": "username", + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", "type": "string" }, { - "description": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", + "description": "the list of nics associated with vm", + "name": "nic", "response": [ { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", + "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": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", + "type": "string" + }, + { + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", + "type": "string" + }, + { + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", "type": "list" }, { - "description": "the account owning the affinity group", - "name": "account", + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "the gateway of the nic", + "name": "gateway", "type": "string" }, { - "description": "the ID of the affinity group", + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" + }, + { + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "the isolation uri of the nic", + "name": "isolationuri", + "type": "string" + }, + { + "description": "the ID of the nic", "name": "id", "type": "string" }, { - "description": "the domain name of the affinity group", - "name": "domain", + "description": "the ip address of the nic", + "name": "ipaddress", "type": "string" }, { - "description": "the name of the affinity group", - "name": "name", + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { - "description": "the description of the affinity group", - "name": "description", + "description": "true if nic is default, false otherwise", + "name": "macaddress", "type": "string" }, { - "description": "the type of the affinity group", - "name": "type", + "description": "the name of the corresponding network", + "name": "networkname", "type": "string" }, { - "description": "the domain ID of the affinity group", - "name": "domainid", + "description": "the IPv6 address of network", + "name": "ip6address", "type": "string" }, { - "description": "the project name of the affinity group", - "name": "project", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "the project ID of the affinity group", - "name": "projectid", + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", "type": "string" + }, + { + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", + "type": "string" + }, + { + "description": "the netmask of the nic", + "name": "netmask", + "type": "string" + }, + { + "description": "the traffic type of the nic", + "name": "traffictype", + "type": "string" + }, + { + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "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 ID of the corresponding network", + "name": "networkid", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" } ], "type": "set" }, + {}, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", + "type": "string" + }, + { + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" + }, + { + "description": "OS type id of the vm", + "name": "ostypeid", + "type": "string" + }, + { + "description": "device ID of the root volume", + "name": "rootdeviceid", "type": "long" }, { - "description": "the write (bytes) of disk on the vm", - "name": "diskkbswrite", + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", "type": "long" }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", + "type": "string" + }, + { + "description": "the project id of the vm", + "name": "projectid", + "type": "string" + }, { "description": "the ID of the ISO attached to the virtual machine", "name": "isoid", "type": "string" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "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", - "name": "memorykbs", - "type": "long" + "description": "device type of the root volume", + "name": "rootdevicetype", + "type": "string" + }, + { + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", + "type": "string" + }, + { + "description": "State of the Service from LB rule", + "name": "servicestate", + "type": "string" }, { "description": "the total number of network traffic bytes sent", @@ -71426,24 +73103,25 @@ "type": "long" }, { - "description": "the internal memory that's free in vm or zero if it can not be calculated", - "name": "memoryintfreekbs", - "type": "long" + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", + "type": "string" }, + {}, { - "description": "the state of the virtual machine", - "name": "state", + "description": "the ID of the disk offering of the virtual machine", + "name": "diskofferingid", "type": "string" }, { - "description": "the target memory in vm", - "name": "memorytargetkbs", - "type": "long" + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" }, { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" + "description": "the name of the template for the virtual machine", + "name": "templatename", + "type": "string" } ] }, @@ -71453,28 +73131,27 @@ "name": "upgradeRouterTemplate", "params": [ { - "description": "upgrades all routers within the specified pod", + "description": "upgrades router with the specified Id", "length": 255, - "name": "podid", - "related": "updatePod,createManagementNetworkIpRange", + "name": "id", + "related": "destroyRouter,listRouters", "required": false, "type": "uuid" }, { - "description": "upgrades all routers owned by the specified domain", + "description": "upgrades all routers within the specified cluster", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", + "name": "clusterid", + "related": "addCluster", "required": false, "type": "uuid" }, { - "description": "upgrades all routers within the specified cluster", + "description": "upgrades all routers owned by the specified account", "length": 255, - "name": "clusterid", - "related": "addCluster", + "name": "account", "required": false, - "type": "uuid" + "type": "string" }, { "description": "upgrades all routers within the specified zone", @@ -71485,19 +73162,20 @@ "type": "uuid" }, { - "description": "upgrades router with the specified Id", + "description": "upgrades all routers within the specified pod", "length": 255, - "name": "id", - "related": "destroyRouter,listRouters", + "name": "podid", + "related": "updatePod,createManagementNetworkIpRange", "required": false, "type": "uuid" }, { - "description": "upgrades all routers owned by the specified account", + "description": "upgrades all routers owned by the specified domain", "length": 255, - "name": "account", + "name": "domainid", + "related": "listDomainChildren,listDomains", "required": false, - "type": "string" + "type": "uuid" } ], "related": "", @@ -71508,12 +73186,12 @@ "name": "jobstatus", "type": "integer" }, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" - } + }, + {} ] }, { @@ -71525,37 +73203,32 @@ "description": "the host ID", "length": 255, "name": "id", - "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,reconnectHost,addBaremetalHost", + "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,reconnectHost", "required": true, "type": "uuid" } ], - "related": "addHost,cancelHostAsDegraded,declareHostAsDegraded,reconnectHost,addBaremetalHost", + "related": "addBaremetalHost,addHost,cancelHostAsDegraded,declareHostAsDegraded,reconnectHost", "response": [ { - "description": "the Pod name of the host", - "name": "podname", + "description": "capabilities of the host", + "name": "capabilities", "type": "string" }, { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", - "type": "long" - }, - { - "description": "true if the host is disconnected. False otherwise.", - "name": "disconnected", - "type": "date" + "description": "the cluster type of the cluster that host belongs to", + "name": "clustertype", + "type": "string" }, { - "description": "the cpu average load on the host", - "name": "cpuloadaverage", - "type": "double" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the incoming network traffic on the host", - "name": "networkkbsread", - "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", @@ -71563,29 +73236,39 @@ "type": "long" }, { - "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 CPU number of the host", - "name": "cpunumber", - "type": "integer" + "description": "the OS category name of the host", + "name": "oscategoryname", + "type": "string" }, { - "description": "the host HA information information", - "name": "hostha", - "type": "hostharesponse" + "description": "the host version", + "name": "version", + "type": "string" }, { - "description": "the amount of the host's memory currently used", - "name": "memoryused", - "type": "long" + "description": "the state of the host", + "name": "state", + "type": "status" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the management server ID of the host", + "name": "managementserverid", + "type": "string" + }, + { + "description": "the Pod name of the host", + "name": "podname", + "type": "string" + }, + { + "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", + "name": "cpuallocatedwithoverprovisioning", + "type": "string" }, { "description": "true if local storage is active, false otherwise", @@ -71593,80 +73276,90 @@ "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 CPU after applying the cpu.overprovisioning.factor", + "name": "cpuwithoverprovisioning", + "type": "string" }, { - "description": "the Pod ID of the host", - "name": "podid", - "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", - "name": "cpuallocated", + "description": "the amount of the host's CPU currently used", + "name": "cpuused", "type": "string" }, { - "description": "the last annotation set on this host by an admin", - "name": "annotation", + "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 CPU number of the host", + "name": "cpunumber", + "type": "integer" }, { - "description": "the last time this host was annotated", - "name": "lastannotated", - "type": "date" + "description": "the amount of the host's CPU currently allocated in percentage", + "name": "cpuallocatedpercentage", + "type": "string" }, { - "description": "the date and time the host was removed", - "name": "removed", - "type": "date" + "description": "the OS category ID of the host", + "name": "oscategoryid", + "type": "string" }, { - "description": "the date and time the host was last pinged", - "name": "lastpinged", - "type": "date" + "description": "the IP address of the host", + "name": "ipaddress", + "type": "string" }, { - "description": "the cluster name of the host", - "name": "clustername", + "description": "Host details in key/value pairs.", + "name": "details", + "type": "map" + }, + { + "description": "the resource state of the host", + "name": "resourcestate", "type": "string" }, { - "description": "the number of CPU sockets on the host", - "name": "cpusockets", - "type": "integer" + "description": "the cpu average load on the host", + "name": "cpuloadaverage", + "type": "double" }, { - "description": "the host out-of-band management information", - "name": "outofbandmanagement", - "type": "outofbandmanagementresponse" + "description": "the amount of the host's memory currently used", + "name": "memoryused", + "type": "long" }, { - "description": "the resource state of the host", - "name": "resourcestate", - "type": "string" + "description": "the host HA information information", + "name": "hostha", + "type": "hostharesponse" }, {}, { - "description": "the amount of the host's CPU currently allocated in percentage", - "name": "cpuallocatedpercentage", - "type": "string" + "description": "the incoming network traffic on the host", + "name": "networkkbsread", + "type": "long" }, - {}, { - "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", - "name": "cpuallocatedwithoverprovisioning", + "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise", + "name": "hahost", + "type": "boolean" + }, + { + "description": "the Zone name of the host", + "name": "zonename", "type": "string" }, + {}, { - "description": "events available for the host", - "name": "events", + "description": "the name of the host", + "name": "name", "type": "string" }, { @@ -71675,41 +73368,51 @@ "type": "hypervisortype" }, { - "description": "the cluster type of the cluster that host belongs to", - "name": "clustertype", - "type": "string" + "description": "the date and time the host was last pinged", + "name": "lastpinged", + "type": "date" + }, + { + "description": "the Pod ID of the host", + "name": "podid", + "type": "string" + }, + { + "description": "the amount of the host's CPU currently allocated in MHz", + "name": "cpuallocatedvalue", + "type": "long" }, { - "description": "the CPU speed of the host", - "name": "cpuspeed", + "description": "the amount of the host's memory currently allocated in bytes", + "name": "memoryallocatedbytes", + "type": "long" + }, + { + "description": "the host's currently allocated disk size", + "name": "disksizeallocated", "type": "long" }, { "description": "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 Y resolution per display", "name": "maxresolutiony", "type": "long" }, { - "description": "Model Name of vGPU", - "name": "vgputype", - "type": "string" - }, - { - "description": "Maximum vgpu can be created with this vgpu type on the given gpu group", - "name": "maxcapacity", + "description": "Video RAM for this vGPU type", + "name": "videoram", "type": "long" }, { @@ -71718,8 +73421,8 @@ "type": "long" }, { - "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" }, { @@ -71728,65 +73431,60 @@ "type": "long" }, { - "description": "Video RAM for this vGPU type", - "name": "videoram", + "description": "Maximum vgpu can be created with this vgpu type on the given gpu group", + "name": "maxcapacity", + "type": "long" + }, + { + "description": "Model Name of vGPU", + "name": "vgputype", + "type": "string" + }, + { + "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 memory currently allocated in percentage", - "name": "memoryallocatedpercentage", - "type": "string" - }, { "description": "the hypervisor version", "name": "hypervisorversion", "type": "string" }, { - "description": "the host type", - "name": "type", - "type": "type" - }, - { - "description": "the amount of the host's CPU currently used", - "name": "cpuused", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor", - "name": "cpuwithoverprovisioning", + "description": "the last annotation set on this host by an admin", + "name": "annotation", "type": "string" }, { - "description": "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": "the host version", - "name": "version", + "description": "the cluster ID of the host", + "name": "clusterid", "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 memory currently allocated in percentage", + "name": "memoryallocatedpercentage", + "type": "string" }, { - "description": "the OS category name of the host", - "name": "oscategoryname", - "type": "string" + "description": "true if the host is disconnected. False otherwise.", + "name": "disconnected", + "type": "date" }, { "description": "comma-separated list of tags for the host", @@ -71794,83 +73492,68 @@ "type": "string" }, { - "description": "the IP address of the host", - "name": "ipaddress", - "type": "string" - }, - { - "description": "the amount of the host's memory after applying the mem.overprovisioning.factor", - "name": "memorywithoverprovisioning", - "type": "string" + "description": "true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise", + "name": "hasenoughcapacity", + "type": "boolean" }, { - "description": "the ID of the host", - "name": "id", - "type": "string" + "description": "the host type", + "name": "type", + "type": "type" }, { - "description": "capabilities of the host", - "name": "capabilities", - "type": "string" + "description": "true if the host has capability to support UEFI boot", + "name": "ueficapability", + "type": "boolean" }, { - "description": "the management server ID of the host", - "name": "managementserverid", + "description": "events available for the host", + "name": "events", "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 name of the host", - "name": "name", - "type": "string" + "description": "the CPU speed of the host", + "name": "cpuspeed", + "type": "long" }, { - "description": "Host details in key/value pairs.", - "name": "details", - "type": "map" + "description": "the 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 admin that annotated this host", + "name": "username", "type": "string" }, { - "description": "the amount of the host's memory currently allocated", - "name": "memoryallocated", - "type": "long" + "description": "the host out-of-band management information", + "name": "outofbandmanagement", + "type": "outofbandmanagementresponse" }, { - "description": "the date and time the host was created", - "name": "created", - "type": "date" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the Zone name of the host", - "name": "zonename", - "type": "string" + "description": "the number of CPU sockets on the host", + "name": "cpusockets", + "type": "integer" }, { - "description": "the OS category ID of the host", - "name": "oscategoryid", + "description": "the ID of the host", + "name": "id", "type": "string" }, { - "description": "the amount of the host's CPU currently allocated in MHz", - "name": "cpuallocatedvalue", - "type": "long" + "description": "the last time this host was annotated", + "name": "lastannotated", + "type": "date" }, { - "description": "the admin that annotated this host", - "name": "username", + "description": "the cluster name of the host", + "name": "clustername", "type": "string" }, { @@ -71879,18 +73562,13 @@ "type": "long" }, { - "description": "the cluster ID of the host", - "name": "clusterid", - "type": "string" - }, - { - "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise", - "name": "hahost", - "type": "boolean" + "description": "the amount of the host's memory currently allocated", + "name": "memoryallocated", + "type": "long" }, { - "description": "the Zone ID of the host", - "name": "zoneid", + "description": "the amount of the host's CPU currently allocated", + "name": "cpuallocated", "type": "string" } ] @@ -71904,182 +73582,186 @@ "description": "network id of the VLAN IP range", "length": 255, "name": "networkid", - "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listF5LoadBalancerNetworks,listNetscalerLoadBalancerNetworks,listBrocadeVcsDeviceNetworks", + "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listBrocadeVcsDeviceNetworks", "required": false, "type": "uuid" }, { - "description": "the domain ID with which the VLAN IP range is associated. If used with the account parameter, returns all VLAN IP ranges for that account in the specified domain.", + "description": "project who will own the VLAN", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", + "name": "projectid", + "related": "listProjectAccounts,activateProject,suspendProject,updateProject", "required": false, "type": "uuid" }, { - "description": "physical network id of the VLAN IP range", + "description": "the Pod ID of the VLAN IP range", "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork", + "name": "podid", + "related": "updatePod,createManagementNetworkIpRange", "required": false, "type": "uuid" }, { - "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": "the ID of the VLAN IP range", + "description": "the ID or VID of the VLAN. Default is an \"untagged\" VLAN.", "length": 255, - "name": "id", - "related": "updateVlanIpRange,listVlanIpRanges,dedicatePublicIpRange", + "name": "vlan", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "the Pod ID of the VLAN IP range", + "description": "the account with which the VLAN IP range is associated. Must be used with the domainId parameter.", "length": 255, - "name": "podid", - "related": "updatePod,createManagementNetworkIpRange", + "name": "account", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "project who will own the VLAN", + "description": "physical network id of the VLAN IP range", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,suspendProject,updateProject", + "name": "physicalnetworkid", + "related": "createPhysicalNetwork", "required": false, "type": "uuid" }, { - "description": "the account with which the VLAN IP range is associated. Must be used with the domainId parameter.", + "description": "the Zone ID of the VLAN IP range", "length": 255, - "name": "account", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "", + "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": "page", + "name": "domainid", + "related": "listDomainChildren,listDomains", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "true if VLAN is of Virtual type, false if Direct", + "description": "", "length": 255, - "name": "forvirtualnetwork", + "name": "pagesize", "required": false, - "type": "boolean" + "type": "integer" }, { - "description": "the ID or VID of the VLAN. Default is an \"untagged\" VLAN.", + "description": "the ID of the VLAN IP range", "length": 255, - "name": "vlan", + "name": "id", + "related": "updateVlanIpRange,listVlanIpRanges,dedicatePublicIpRange", "required": false, - "type": "string" + "type": "uuid" }, { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, { - "description": "the Zone ID of the VLAN IP range", + "description": "List by keyword", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" } ], "related": "updateVlanIpRange,dedicatePublicIpRange", "response": [ { - "description": "the ID or VID of the VLAN.", - "name": "vlan", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "the domain name of the VLAN IP range", - "name": "domain", - "type": "string" + "description": "indicates whether VLAN IP range is dedicated to system vms or not", + "name": "forsystemvms", + "type": "boolean" }, { - "description": "the ID of the VLAN IP range", - "name": "id", + "description": "the end ipv6 of the VLAN IP range", + "name": "endipv6", "type": "string" }, { - "description": "the project name of the vlan range", - "name": "project", + "description": "the start ip of the VLAN IP range", + "name": "startip", "type": "string" }, { - "description": "the gateway of the VLAN IP range", - "name": "gateway", + "description": "the project id of the vlan range", + "name": "projectid", "type": "string" }, { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "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": "indicates whether VLAN IP range is dedicated to system vms or not", - "name": "forsystemvms", - "type": "boolean" + "description": "the description of the VLAN IP range", + "name": "description", + "type": "string" }, { - "description": "the Zone ID of the VLAN IP range", - "name": "zoneid", + "description": "the start ipv6 of the VLAN IP range", + "name": "startipv6", "type": "string" }, { - "description": "the end ipv6 of the VLAN IP range", - "name": "endipv6", + "description": "the netmask of the VLAN IP range", + "name": "netmask", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the cidr of the VLAN IP range", + "name": "cidr", + "type": "string" }, { - "description": "the project id of the vlan range", - "name": "projectid", + "description": "the ID of the VLAN IP range", + "name": "id", "type": "string" }, { - "description": "the network id of vlan range", - "name": "networkid", + "description": "the gateway of the VLAN IP range", + "name": "gateway", "type": "string" }, { - "description": "the domain ID of the VLAN IP range", - "name": "domainid", + "description": "the project name of the vlan range", + "name": "project", "type": "string" }, { - "description": "the virtual network for the VLAN IP range", - "name": "forvirtualnetwork", - "type": "boolean" + "description": "the physical network this belongs to", + "name": "physicalnetworkid", + "type": "string" }, { - "description": "the Pod name for the VLAN IP range", - "name": "podname", + "description": "the domain ID of the VLAN IP range", + "name": "domainid", "type": "string" }, { @@ -72093,41 +73775,42 @@ "type": "string" }, { - "description": "the start ipv6 of the VLAN IP range", - "name": "startipv6", + "description": "the Pod ID for the VLAN IP range", + "name": "podid", "type": "string" }, { - "description": "the account of the VLAN IP range", - "name": "account", + "description": "the domain name of the VLAN IP range", + "name": "domain", "type": "string" }, + {}, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the Zone ID of the VLAN IP range", + "name": "zoneid", "type": "string" }, { - "description": "the netmask of the VLAN IP range", - "name": "netmask", - "type": "string" + "description": "the virtual network for the VLAN IP range", + "name": "forvirtualnetwork", + "type": "boolean" }, - {}, { - "description": "the start ip of the VLAN IP range", - "name": "startip", + "description": "the account of the VLAN IP range", + "name": "account", "type": "string" }, { - "description": "the description of the VLAN IP range", - "name": "description", + "description": "the network id of vlan range", + "name": "networkid", "type": "string" }, { - "description": "the Pod ID for the VLAN IP range", - "name": "podid", + "description": "the ID or VID of the VLAN.", + "name": "vlan", "type": "string" - } + }, + {} ] }, { @@ -72136,9 +73819,9 @@ "name": "updateZone", "params": [ { - "description": "Allocation state of this cluster for allocation of new resources", + "description": "the second DNS for the Zone", "length": 255, - "name": "allocationstate", + "name": "dns2", "required": false, "type": "string" }, @@ -72157,12 +73840,41 @@ "type": "string" }, { - "description": "the second DNS for the Zone", + "description": "updates a private zone to public if set, but not vice-versa", "length": 255, - "name": "dns2", + "name": "ispublic", + "required": false, + "type": "boolean" + }, + { + "description": "sort key of the zone, integer", + "length": 255, + "name": "sortkey", + "required": false, + "type": "integer" + }, + { + "description": "true if local storage offering enabled, false otherwise", + "length": 255, + "name": "localstorageenabled", + "required": false, + "type": "boolean" + }, + { + "description": "the first DNS for the Zone", + "length": 255, + "name": "dns1", "required": false, "type": "string" }, + { + "description": "the ID of the Zone", + "length": 255, + "name": "id", + "related": "createZone,updateZone,listZones,listZones", + "required": true, + "type": "uuid" + }, { "description": "Network domain name for the networks in the zone; empty string will update domain with NULL value", "length": 255, @@ -72171,9 +73883,44 @@ "type": "string" }, { - "description": "the first DNS for the Zone", + "description": "the second internal DNS for the Zone", "length": 255, - "name": "dns1", + "name": "internaldns2", + "required": false, + "type": "string" + }, + { + "description": "the first internal DNS for the Zone", + "length": 255, + "name": "internaldns1", + "required": false, + "type": "string" + }, + { + "description": "the dhcp Provider for the Zone", + "length": 255, + "name": "dhcpprovider", + "required": false, + "type": "string" + }, + { + "description": "the dns search order list", + "length": 255, + "name": "dnssearchorder", + "required": false, + "type": "list" + }, + { + "description": "Allocation state of this cluster for allocation of new resources", + "length": 255, + "name": "allocationstate", + "required": false, + "type": "string" + }, + { + "description": "the first DNS for IPv6 network in the Zone", + "length": 255, + "name": "ip6dns1", "required": false, "type": "string" }, @@ -72185,138 +73932,140 @@ "type": "map" }, { - "description": "the first internal DNS for the Zone", - "length": 255, - "name": "internaldns1", - "required": false, + "description": "the second DNS for IPv6 network in the Zone", + "length": 255, + "name": "ip6dns2", + "required": false, + "type": "string" + } + ], + "related": "createZone,listZones,listZones", + "response": [ + { + "description": "the first IPv6 DNS for the Zone", + "name": "ip6dns1", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the display text of the zone", + "name": "displaytext", + "type": "string" + }, + { + "description": "the second DNS for the Zone", + "name": "dns2", + "type": "string" + }, + { + "description": "Network domain name for the networks in the zone", + "name": "domain", + "type": "string" + }, + { + "description": "the first DNS for the Zone", + "name": "dns1", + "type": "string" + }, + { + "description": "the name of the containing domain, null for public zones", + "name": "domainname", + "type": "string" + }, + { + "description": "Meta data associated with the zone (key/value pairs)", + "name": "resourcedetails", + "type": "map" + }, + { + "description": "the UUID of the containing domain, null for public zones", + "name": "domainid", + "type": "string" + }, + { + "description": "Zone id", + "name": "id", "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", + "name": "guestcidraddress", + "type": "string" }, { - "description": "the second DNS for IPv6 network in the Zone", - "length": 255, + "description": "the second IPv6 DNS for the Zone", "name": "ip6dns2", - "required": false, "type": "string" }, { "description": "the second internal DNS for the Zone", - "length": 255, "name": "internaldns2", - "required": false, - "type": "string" - }, - { - "description": "the dns search order list", - "length": 255, - "name": "dnssearchorder", - "required": false, - "type": "list" - }, - { - "description": "the first DNS for IPv6 network in the Zone", - "length": 255, - "name": "ip6dns1", - "required": false, "type": "string" }, { - "description": "updates a private zone to public if set, but not vice-versa", - "length": 255, - "name": "ispublic", - "required": false, + "description": "true if local storage offering enabled, false otherwise", + "name": "localstorageenabled", "type": "boolean" }, { "description": "the dhcp Provider for the Zone", - "length": 255, "name": "dhcpprovider", - "required": false, "type": "string" }, { - "description": "the ID of the Zone", - "length": 255, - "name": "id", - "related": "createZone,updateZone,listZones,listZones", - "required": true, - "type": "uuid" + "description": "Zone Token", + "name": "zonetoken", + "type": "string" }, + {}, { - "description": "sort key of the zone, integer", - "length": 255, - "name": "sortkey", - "required": false, + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" - } - ], - "related": "createZone,listZones,listZones", - "response": [ + }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the network type of the zone; can be Basic or Advanced", + "name": "networktype", + "type": "string" }, { - "description": "the allocation state of the cluster", - "name": "allocationstate", + "description": "the first internal DNS for the Zone", + "name": "internaldns1", "type": "string" }, { - "description": "true if security groups support is enabled, false otherwise", - "name": "securitygroupsenabled", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "the display text of the zone", - "name": "displaytext", + "description": "Zone description", + "name": "description", "type": "string" }, { - "description": "Zone id", - "name": "id", - "type": "string" + "description": "true if security groups support is enabled, false otherwise", + "name": "securitygroupsenabled", + "type": "boolean" }, { - "description": "Zone name", - "name": "name", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { "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 name", - "name": "clustername", - "type": "string" - }, - { - "description": "the capacity currently in use", - "name": "capacityused", - "type": "long" - }, - { - "description": "the capacity currently in allocated", - "name": "capacityallocated", - "type": "long" - }, { "description": "the capacity name", "name": "name", @@ -72328,14 +74077,19 @@ "type": "string" }, { - "description": "the Cluster ID", - "name": "clusterid", + "description": "the Pod ID", + "name": "podid", "type": "string" }, { - "description": "the capacity type", - "name": "type", - "type": "short" + "description": "the Zone name", + "name": "zonename", + "type": "string" + }, + { + "description": "the capacity currently in allocated", + "name": "capacityallocated", + "type": "long" }, { "description": "the total capacity available", @@ -72343,41 +74097,42 @@ "type": "long" }, { - "description": "the Pod ID", - "name": "podid", + "description": "the Cluster name", + "name": "clustername", "type": "string" }, { "description": "the percentage of capacity currently in use", "name": "percentused", "type": "string" + }, + { + "description": "the Cluster ID", + "name": "clusterid", + "type": "string" + }, + { + "description": "the capacity currently in use", + "name": "capacityused", + "type": "long" + }, + { + "description": "the capacity type", + "name": "type", + "type": "short" } ], "type": "list" }, { - "description": "Zone Token", - "name": "zonetoken", - "type": "string" - }, - { - "description": "Meta data associated with the zone (key/value pairs)", - "name": "resourcedetails", - "type": "map" - }, - { - "description": "the second IPv6 DNS for the Zone", - "name": "ip6dns2", - "type": "string" - }, - { - "description": "the name of the containing domain, null for public zones", - "name": "domainname", + "description": "the allocation state of the cluster", + "name": "allocationstate", "type": "string" }, + {}, { - "description": "the first DNS for the Zone", - "name": "dns1", + "description": "Zone name", + "name": "name", "type": "string" }, { @@ -72385,129 +74140,57 @@ "name": "tags", "response": [ { - "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": "tag key name", + "name": "key", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" } ], "type": "set" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - {}, - { - "description": "the guest CIDR address for the Zone", - "name": "guestcidraddress", - "type": "string" - }, - { - "description": "the network type of the zone; can be Basic or Advanced", - "name": "networktype", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "Zone description", - "name": "description", - "type": "string" - }, - { - "description": "the first internal DNS for the Zone", - "name": "internaldns1", - "type": "string" - }, - { - "description": "the first IPv6 DNS for the Zone", - "name": "ip6dns1", - "type": "string" - }, - { - "description": "the second DNS for the Zone", - "name": "dns2", - "type": "string" - }, - { - "description": "the UUID of the containing domain, null for public zones", - "name": "domainid", - "type": "string" - }, - { - "description": "the second internal DNS for the Zone", - "name": "internaldns2", - "type": "string" - }, - {}, - { - "description": "Network domain name for the networks in the zone", - "name": "domain", - "type": "string" - }, - { - "description": "true if local storage offering enabled, false otherwise", - "name": "localstorageenabled", - "type": "boolean" - }, - { - "description": "the dhcp Provider for the Zone", - "name": "dhcpprovider", - "type": "string" } ] }, @@ -72517,10 +74200,17 @@ "name": "extractVolume", "params": [ { - "description": "the ID of the zone where the volume is located", + "description": "the url to which the volume would be extracted", + "length": 2048, + "name": "url", + "required": false, + "type": "string" + }, + { + "description": "the ID of the volume", "length": 255, - "name": "zoneid", - "related": "createZone,listZones,listZones", + "name": "id", + "related": "attachVolume,createVolume,listVolumes,migrateVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", "required": true, "type": "uuid" }, @@ -72532,43 +74222,30 @@ "type": "string" }, { - "description": "the url to which the volume would be extracted", - "length": 2048, - "name": "url", - "required": false, - "type": "string" - }, - { - "description": "the ID of the volume", + "description": "the ID of the zone where the volume is located", "length": 255, - "name": "id", - "related": "attachVolume,createVolume,listVolumes,migrateVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", + "name": "zoneid", + "related": "createZone,listZones,listZones", "required": true, "type": "uuid" } ], "related": "extractTemplate", "response": [ - {}, - { - "description": "the percentage of the entity uploaded to the specified location", - "name": "uploadpercentage", - "type": "integer" - }, { - "description": "the account id to which the extracted object belongs", - "name": "accountid", + "description": "if mode = upload then url of the uploaded entity. if mode = download the url from which the entity can be downloaded", + "name": "url", "type": "string" }, { - "description": "zone ID the object was extracted from", - "name": "zoneid", + "description": "the status of the extraction", + "name": "status", "type": "string" }, { - "description": "the time and date the object was created", - "name": "created", - "type": "date" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { "description": "the current status of the latest async job acting on this object", @@ -72576,20 +74253,14 @@ "type": "integer" }, { - "description": "the mode of extraction - upload or download", - "name": "extractMode", - "type": "string" - }, - {}, - { - "description": "type of the storage", - "name": "storagetype", + "description": "the state of the extracted object", + "name": "state", "type": "string" }, { - "description": "the status of the extraction", - "name": "status", - "type": "string" + "description": "the time and date the object was created", + "name": "created", + "type": "date" }, { "description": "", @@ -72597,13 +74268,8 @@ "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 state of the extracted object", - "name": "state", + "description": "the id of extracted object", + "name": "id", "type": "string" }, { @@ -72612,8 +74278,8 @@ "type": "string" }, { - "description": "zone name the object was extracted from", - "name": "zonename", + "description": "type of the storage", + "name": "storagetype", "type": "string" }, { @@ -72622,13 +74288,30 @@ "type": "string" }, { - "description": "the id of extracted object", - "name": "id", + "description": "the mode of extraction - upload or download", + "name": "extractMode", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the percentage of the entity uploaded to the specified location", + "name": "uploadpercentage", + "type": "integer" + }, + {}, + {}, + { + "description": "zone name the object was extracted from", + "name": "zonename", + "type": "string" + }, + { + "description": "the account id to which the extracted object belongs", + "name": "accountid", + "type": "string" + }, + { + "description": "zone ID the object was extracted from", + "name": "zoneid", "type": "string" } ] @@ -72639,19 +74322,19 @@ "name": "listProjectAccounts", "params": [ { - "description": "list accounts of the project by project role id", + "description": "", "length": 255, - "name": "projectroleid", - "related": "updateProjectRole", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "list accounts of the project by role", + "description": "list accounts of the project by project role id", "length": 255, - "name": "role", + "name": "projectroleid", + "related": "updateProjectRole", "required": false, - "type": "string" + "type": "uuid" }, { "description": "ID of the project", @@ -72669,18 +74352,19 @@ "type": "string" }, { - "description": "", + "description": "list invitation by user ID", "length": 255, - "name": "pagesize", + "name": "userid", + "related": "createUser,disableUser,enableUser,getUser,listUsers,lockUser,updateUser", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "", + "description": "list accounts of the project by role", "length": 255, - "name": "page", + "name": "role", "required": false, - "type": "integer" + "type": "string" }, { "description": "list accounts of the project by account name", @@ -72690,65 +74374,81 @@ "type": "string" }, { - "description": "list invitation by user ID", + "description": "", "length": 255, - "name": "userid", - "related": "createUser,disableUser,enableUser,getUser,listUsers,lockUser,updateUser", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" } ], "related": "activateProject,suspendProject,updateProject", "response": [ - { - "description": "the date this project was created", - "name": "created", - "type": "date" - }, - { - "description": "the total number of templates available to be created by this project", - "name": "templateavailable", - "type": "string" - }, { "description": "the total primary storage space (in GiB) owned by project", "name": "primarystoragetotal", "type": "long" }, { - "description": "the total number of cpu cores available to be created for this project", - "name": "cpuavailable", - "type": "string" - }, - { - "description": "the total number of public ip addresses allocated for this project", - "name": "iptotal", - "type": "long" - }, - { - "description": "the total number of public ip addresses available for this project to acquire", - "name": "ipavailable", - "type": "string" - }, - { - "description": "the total number of snapshots stored by this project", - "name": "snapshottotal", - "type": "long" - }, - { - "description": "the total number of snapshots available for this project", - "name": "snapshotavailable", - "type": "string" - }, - { - "description": "the total number of virtual machines available for this project to acquire", - "name": "vmavailable", - "type": "string" + "description": "the list of resource tags associated with vm", + "name": "tags", + "response": [ + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + } + ], + "type": "list" }, { - "description": "the total volume which can be used by this project", - "name": "volumelimit", - "type": "string" + "description": "the total memory (in MB) owned by project", + "name": "memorytotal", + "type": "long" }, { "description": "the total number of templates which have been created by this project", @@ -72756,23 +74456,8 @@ "type": "long" }, { - "description": "the total number of cpu cores owned by project", - "name": "cputotal", - "type": "long" - }, - { - "description": "the displaytext of the project", - "name": "displaytext", - "type": "string" - }, - { - "description": "the total number of vpcs available to be created for this project", - "name": "vpcavailable", - "type": "string" - }, - { - "description": "the project account name of the project", - "name": "projectaccountname", + "description": "the state of the project", + "name": "state", "type": "string" }, { @@ -72780,27 +74465,25 @@ "name": "memoryavailable", "type": "string" }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - {}, { "description": "the total volume available for this project", "name": "volumeavailable", "type": "string" }, { - "description": "the total number of networks available to be created for this project", - "name": "networkavailable", + "description": "the account name of the project's owners", + "name": "owner", + "type": "list" + }, + { + "description": "the total primary storage space (in GiB) available to be used for this project", + "name": "primarystorageavailable", "type": "string" }, - {}, { - "description": "the total volume being used by this project", - "name": "volumetotal", - "type": "long" + "description": "the total number of networks the project can own", + "name": "networklimit", + "type": "string" }, { "description": "the total secondary storage space (in GiB) owned by project", @@ -72808,43 +74491,33 @@ "type": "float" }, { - "description": "the total memory (in MB) the project can own", - "name": "memorylimit", + "description": "the total number of templates available to be created by this project", + "name": "templateavailable", "type": "string" }, { - "description": "the total number of cpu cores the project can own", - "name": "cpulimit", + "description": "the id of the project", + "name": "id", "type": "string" }, { - "description": "the total memory (in MB) owned by project", - "name": "memorytotal", - "type": "long" - }, - { - "description": "the total primary storage space (in GiB) available to be used for this project", - "name": "primarystorageavailable", + "description": "the total number of cpu cores the project can own", + "name": "cpulimit", "type": "string" }, { - "description": "the total number of virtual machines stopped for this project", - "name": "vmstopped", - "type": "integer" - }, - { - "description": "the account name of the project's owners", - "name": "owner", - "type": "list" + "description": "the displaytext of the project", + "name": "displaytext", + "type": "string" }, { - "description": "the total number of public ip addresses this project can acquire", - "name": "iplimit", + "description": "the total number of snapshots available for this project", + "name": "snapshotavailable", "type": "string" }, { - "description": "the id of the project", - "name": "id", + "description": "the total number of vpcs the project can own", + "name": "vpclimit", "type": "string" }, { @@ -72853,23 +74526,23 @@ "type": "string" }, { - "description": "the total number of vpcs owned by project", - "name": "vpctotal", - "type": "long" + "description": "the total secondary storage space (in GiB) the project can own", + "name": "secondarystoragelimit", + "type": "string" }, { - "description": "the total number of networks owned by project", - "name": "networktotal", - "type": "long" + "description": "the date this project was created", + "name": "created", + "type": "date" }, { - "description": "the total number of virtual machines that can be deployed by this project", - "name": "vmlimit", - "type": "string" + "description": "the total number of snapshots stored by this project", + "name": "snapshottotal", + "type": "long" }, { - "description": "the total number of snapshots which can be stored by this project", - "name": "snapshotlimit", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -72878,215 +74551,134 @@ "type": "integer" }, { - "description": "the state of the project", - "name": "state", - "type": "string" - }, - { - "description": "the name of the project", - "name": "name", + "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 total number of vpcs owned by project", + "name": "vpctotal", + "type": "long" }, { - "description": "the list of resource tags associated with vm", - "name": "tags", - "response": [ - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - } - ], - "type": "list" + "description": "the total number of vpcs available to be created for this project", + "name": "vpcavailable", + "type": "string" }, { - "description": "the domain name where the project belongs to", - "name": "domain", - "type": "string" + "description": "the total number of virtual machines stopped for this project", + "name": "vmstopped", + "type": "integer" }, { - "description": "the total number of networks the project can own", - "name": "networklimit", + "description": "the total memory (in MB) the project can own", + "name": "memorylimit", "type": "string" }, { - "description": "the total number of templates which can be created by this project", - "name": "templatelimit", + "description": "the name of the project", + "name": "name", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the total primary storage space (in GiB) the project can own", + "name": "primarystoragelimit", "type": "string" }, + {}, { - "description": "the total secondary storage space (in GiB) available to be used for this project", - "name": "secondarystorageavailable", + "description": "the total number of public ip addresses available for this project to acquire", + "name": "ipavailable", "type": "string" }, { - "description": "the total number of vpcs the project can own", - "name": "vpclimit", + "description": "the total volume which can be used by this project", + "name": "volumelimit", "type": "string" }, { - "description": "the total number of virtual machines deployed by this project", - "name": "vmtotal", + "description": "the total number of networks owned by project", + "name": "networktotal", "type": "long" }, { - "description": "the total secondary storage space (in GiB) the project can own", - "name": "secondarystoragelimit", + "description": "the total number of networks available to be created for this project", + "name": "networkavailable", "type": "string" }, { - "description": "the total primary storage space (in GiB) the project can own", - "name": "primarystoragelimit", + "description": "the total number of cpu cores available to be created for this project", + "name": "cpuavailable", "type": "string" - } - ], - "since": "3.0.0" - }, - { - "description": "Adds F5 external load balancer appliance.", - "isasync": false, - "name": "addExternalLoadBalancer", - "params": [ - { - "description": "Zone in which to add the external load balancer appliance.", - "length": 255, - "name": "zoneid", - "related": "createZone,listZones,listZones", - "required": true, - "type": "uuid" }, { - "description": "Password of the external load balancer appliance.", - "length": 255, - "name": "password", - "required": true, + "description": "the total secondary storage space (in GiB) available to be used for this project", + "name": "secondarystorageavailable", "type": "string" }, { - "description": "Username of the external load balancer appliance.", - "length": 255, - "name": "username", - "required": true, - "type": "string" + "description": "the total number of cpu cores owned by project", + "name": "cputotal", + "type": "long" }, { - "description": "URL of the external load balancer appliance.", - "length": 255, - "name": "url", - "required": true, - "type": "string" - } - ], - "related": "", - "response": [ + "description": "the total volume being used by this project", + "name": "volumetotal", + "type": "long" + }, { - "description": "the ID of the external load balancer", - "name": "id", + "description": "the project account name of the project", + "name": "projectaccountname", "type": "string" }, { - "description": "the username that's used to log in to the external load balancer", - "name": "username", + "description": "the domain name where the project belongs to", + "name": "domain", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the total number of templates which can be created by this project", + "name": "templatelimit", + "type": "string" }, { - "description": "the private interface of the external load balancer", - "name": "privateinterface", + "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", - "type": "string" + "description": "the total number of virtual machines deployed by this project", + "name": "vmtotal", + "type": "long" }, { - "description": "the number of times to retry requests to the external load balancer", - "name": "numretries", + "description": "the total number of virtual machines that can be deployed by this project", + "name": "vmlimit", "type": "string" }, { - "description": "the management IP address of the external load balancer", - "name": "ipaddress", - "type": "string" + "description": "the total number of public ip addresses allocated for this project", + "name": "iptotal", + "type": "long" }, { - "description": "the zone ID of the external load balancer", - "name": "zoneid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the public interface of the external load balancer", - "name": "publicinterface", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, - {}, { - "description": "the ID of the network device", - "name": "id", + "description": "the total number of virtual machines available for this project to acquire", + "name": "vmavailable", "type": "string" } - ] + ], + "since": "3.0.0" }, { "description": "Updates an existing autoscale policy.", @@ -73100,6 +74692,13 @@ "required": false, "type": "integer" }, + { + "description": "the duration for which the conditions have to be true before action is taken", + "length": 255, + "name": "duration", + "required": false, + "type": "integer" + }, { "description": "the ID of the autoscale policy", "length": 255, @@ -73108,13 +74707,6 @@ "required": true, "type": "uuid" }, - { - "description": "the duration for which the conditions have to be true before action is taken", - "length": 255, - "name": "duration", - "required": false, - "type": "integer" - }, { "description": "the list of IDs of the conditions that are being evaluated on every interval", "length": 255, @@ -73127,8 +74719,8 @@ "related": "listAutoScalePolicies", "response": [ { - "description": "the domain name of the autoscale policy", - "name": "domain", + "description": "the project name of the autoscale policy", + "name": "project", "type": "string" }, { @@ -73137,41 +74729,31 @@ "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", + "description": "the domain ID of the autoscale policy", + "name": "domainid", "type": "string" }, { - "description": "the account owning the autoscale policy", - "name": "account", + "description": "the domain name of the autoscale policy", + "name": "domain", "type": "string" }, - { - "description": "the cool down period for which the policy should not be evaluated after the action has been taken", - "name": "quiettime", - "type": "integer" - }, {}, { - "description": "the domain ID of the autoscale policy", - "name": "domainid", - "type": "string" - }, - { - "description": "the project name of the autoscale policy", - "name": "project", + "description": "the action to be executed if all the conditions evaluate to true for the specified duration.", + "name": "action", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the list of IDs of the conditions that are being evaluated on every interval", + "name": "conditions", + "type": "list" }, { "description": "the duration for which the conditions have to be true before action is taken", @@ -73179,9 +74761,19 @@ "type": "integer" }, { - "description": "the list of IDs of the conditions that are being evaluated on every interval", - "name": "conditions", - "type": "list" + "description": "the cool down period for which the policy should not be evaluated after the action has been taken", + "name": "quiettime", + "type": "integer" + }, + { + "description": "the autoscale policy ID", + "name": "id", + "type": "string" + }, + { + "description": "the account owning the autoscale policy", + "name": "account", + "type": "string" }, { "description": "the current status of the latest async job acting on this object", @@ -73196,49 +74788,40 @@ "name": "createDiskOffering", "params": [ { - "description": "length (in seconds) of the burst", - "length": 255, - "name": "iopswriteratemaxlength", - "required": false, - "type": "long" - }, - { - "description": "an optional field, whether to display the offering to the end user or not.", + "description": "the ID of the containing domain(s), null for public offerings", "length": 255, - "name": "displayoffering", + "name": "domainid", + "related": "listDomainChildren,listDomains", "required": false, - "type": "boolean" + "type": "list" }, { - "description": "Name of the storage policy defined at vCenter, this is applicable only for VMware", + "description": "io requests write rate of the disk offering", "length": 255, - "name": "storagepolicy", - "related": "listVsphereStoragePolicies", + "name": "iopswriterate", "required": false, - "since": "4.15", - "type": "uuid" + "type": "long" }, { - "description": "the cache mode to use for this disk offering. none, writeback or writethrough", + "description": "bytes read rate of the disk offering", "length": 255, - "name": "cachemode", + "name": "bytesreadrate", "required": false, - "since": "4.14", - "type": "string" + "type": "long" }, { - "description": "burst requests read rate of the disk offering", + "description": "length (in seconds) of the burst", "length": 255, - "name": "iopsreadratemax", + "name": "iopsreadratemaxlength", "required": false, "type": "long" }, { - "description": "bytes write rate of the disk offering", + "description": "provisioning type used to create volumes. Valid values are thin, sparse, fat.", "length": 255, - "name": "byteswriterate", + "name": "provisioningtype", "required": false, - "type": "long" + "type": "string" }, { "description": "tags for the disk offering", @@ -73248,69 +74831,70 @@ "type": "string" }, { - "description": "io requests read rate of the disk offering", + "description": "the cache mode to use for this disk offering. none, writeback or writethrough", "length": 255, - "name": "iopsreadrate", + "name": "cachemode", "required": false, - "type": "long" + "since": "4.14", + "type": "string" }, { "description": "length (in seconds) of the burst", "length": 255, - "name": "iopsreadratemaxlength", + "name": "bytesreadratemaxlength", "required": false, "type": "long" }, { - "description": "the ID of the containing domain(s), null for public offerings", + "description": "min iops of the disk offering", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", + "name": "miniops", "required": false, - "type": "list" + "type": "long" }, { - "description": "details to specify disk offering parameters", + "description": "length (in seconds) of the burst", "length": 255, - "name": "details", + "name": "iopswriteratemaxlength", "required": false, - "since": "4.16", - "type": "map" + "type": "long" }, { - "description": "burst bytes read rate of the disk offering", + "description": "whether disk offering size is custom or not", "length": 255, - "name": "bytesreadratemax", + "name": "customized", "required": false, - "type": "long" + "type": "boolean" }, { - "description": "provisioning type used to create volumes. Valid values are thin, sparse, fat.", + "description": "burst io requests write rate of the disk offering", "length": 255, - "name": "provisioningtype", + "name": "iopswriteratemax", "required": false, - "type": "string" + "type": "long" }, { - "description": "the storage type of the disk offering. Values are local and shared.", + "description": "an optional field, whether to display the offering to the end user or not.", "length": 255, - "name": "storagetype", + "name": "displayoffering", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "size of the disk offering in GB (1GB = 1,073,741,824 bytes)", + "description": "whether disk offering iops is custom or not", "length": 255, - "name": "disksize", + "name": "customizediops", "required": false, - "type": "long" + "type": "boolean" }, { - "description": "name of the disk offering", + "description": "Name of the storage policy defined at vCenter, this is applicable only for VMware", "length": 255, - "name": "name", - "required": true, - "type": "string" + "name": "storagepolicy", + "related": "listVsphereStoragePolicies", + "required": false, + "since": "4.15", + "type": "uuid" }, { "description": "burst bytes write rate of the disk offering", @@ -73320,88 +74904,104 @@ "type": "long" }, { - "description": "whether disk offering size is custom or not", + "description": "the storage type of the disk offering. Values are local and shared.", "length": 255, - "name": "customized", + "name": "storagetype", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "the ID of the containing zone(s), null for public offerings", + "description": "alternate display text of the disk offering", + "length": 4096, + "name": "displaytext", + "required": true, + "type": "string" + }, + { + "description": "max iops of the disk offering", "length": 255, - "name": "zoneid", - "related": "createZone,listZones,listZones", + "name": "maxiops", "required": false, - "since": "4.13", - "type": "list" + "type": "long" }, { - "description": "io requests write rate of the disk offering", + "description": "burst bytes read rate of the disk offering", "length": 255, - "name": "iopswriterate", + "name": "bytesreadratemax", "required": false, "type": "long" }, { - "description": "burst io requests write rate of the disk offering", + "description": "size of the disk offering in GB (1GB = 1,073,741,824 bytes)", "length": 255, - "name": "iopswriteratemax", + "name": "disksize", "required": false, "type": "long" }, { - "description": "min iops of the disk offering", + "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": "miniops", + "name": "disksizestrictness", "required": false, - "type": "long" + "since": "4.17", + "type": "boolean" }, { - "description": "max iops of the disk offering", + "description": "the ID of the containing zone(s), null for public offerings", "length": 255, - "name": "maxiops", + "name": "zoneid", + "related": "createZone,listZones,listZones", + "required": false, + "since": "4.13", + "type": "list" + }, + { + "description": "length (in seconds) of the burst", + "length": 255, + "name": "byteswriteratemaxlength", "required": false, "type": "long" }, { - "description": "length (in seconds) of the burst", + "description": "burst requests read rate of the disk offering", "length": 255, - "name": "bytesreadratemaxlength", + "name": "iopsreadratemax", "required": false, "type": "long" }, { - "description": "alternate display text of the disk offering", - "length": 4096, - "name": "displaytext", + "description": "name of the disk offering", + "length": 255, + "name": "name", "required": true, "type": "string" }, { - "description": "bytes read rate of the disk offering", + "description": "details to specify disk offering parameters", "length": 255, - "name": "bytesreadrate", + "name": "details", "required": false, - "type": "long" + "since": "4.16", + "type": "map" }, { - "description": "whether disk offering iops is custom or not", + "description": "Hypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware)", "length": 255, - "name": "customizediops", + "name": "hypervisorsnapshotreserve", "required": false, - "type": "boolean" + "type": "integer" }, { - "description": "Hypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware)", + "description": "io requests read rate of the disk offering", "length": 255, - "name": "hypervisorsnapshotreserve", + "name": "iopsreadrate", "required": false, - "type": "integer" + "type": "long" }, { - "description": "length (in seconds) of the burst", + "description": "bytes write rate of the disk offering", "length": 255, - "name": "byteswriteratemaxlength", + "name": "byteswriterate", "required": false, "type": "long" } @@ -73409,44 +75009,48 @@ "related": "", "response": [ { - "description": "io requests write rate of the disk offering", - "name": "diskIopsWriteRate", - "type": "long" + "description": "the storage type for this disk offering", + "name": "storagetype", + "type": "string" }, { - "description": "burst io requests write rate of the disk offering", - "name": "diskIopsWriteRateMax", + "description": "length (in seconds) of the burst", + "name": "diskIopsWriteRateMaxLength", "type": "long" }, { - "description": "length (in seconds) of the burst", - "name": "diskBytesWriteRateMaxLength", + "description": "io requests read rate of the disk offering", + "name": "diskIopsReadRate", "type": "long" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "domainid", "type": "string" }, { - "description": "the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zone", - "type": "string" + "description": "the max iops of the disk offering", + "name": "maxiops", + "type": "long" }, { - "description": "provisioning type used to create volumes. Valid values are thin, sparse, fat.", - "name": "provisioningtype", - "type": "string" + "description": "burst bytes read rate of the disk offering", + "name": "diskBytesReadRateMax", + "type": "long" }, { - "description": "the name of the disk offering", - "name": "name", - "type": "string" + "description": "bytes write rate of the disk offering", + "name": "diskBytesWriteRate", + "type": "long" }, { - "description": "io requests read rate of the disk offering", - "name": "diskIopsReadRate", + "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" }, { @@ -73455,24 +75059,24 @@ "type": "boolean" }, { - "description": "the size of the disk offering in GB", - "name": "disksize", + "description": "length (in seconds) of the burst", + "name": "diskBytesWriteRateMaxLength", "type": "long" }, { - "description": "the cache mode to use for this disk offering. none, writeback or writethrough", - "name": "cacheMode", + "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "zoneid", "type": "string" }, { - "description": "bytes read rate of the disk offering", - "name": "diskBytesReadRate", - "type": "long" + "description": "the tags for the disk offering", + "name": "tags", + "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 vsphere storage policy tagged to the disk offering in case of VMware", + "name": "vspherestoragepolicy", + "type": "string" }, { "description": "whether to display the offering to the end user or not.", @@ -73480,49 +75084,59 @@ "type": "boolean" }, { - "description": "the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "domain", - "type": "string" + "description": "length (in seconds) of the burst", + "name": "diskBytesReadRateMaxLength", + "type": "long" }, { - "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zoneid", - "type": "string" + "description": "the date this disk offering was created", + "name": "created", + "type": "date" }, { - "description": "true if disk offering uses custom iops, false otherwise", - "name": "iscustomizediops", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "length (in second) of the burst", - "name": "diskIopsReadRateMaxLength", + "description": "the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "domain", + "type": "string" + }, + { + "description": "bytes read rate of the disk offering", + "name": "diskBytesReadRate", "type": "long" }, { - "description": "burst io requests read rate of the disk offering", - "name": "diskIopsReadRateMax", + "description": "the size of the disk offering in GB", + "name": "disksize", "type": "long" }, { - "description": "the tags for the disk offering", - "name": "tags", + "description": "provisioning type used to create volumes. Valid values are thin, sparse, fat.", + "name": "provisioningtype", "type": "string" }, + {}, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "Hypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware)", + "name": "hypervisorsnapshotreserve", + "type": "integer" }, { - "description": "the date this disk offering was created", - "name": "created", - "type": "date" + "description": "length (in second) of the burst", + "name": "diskIopsReadRateMaxLength", + "type": "long" }, - {}, { - "description": "the vsphere storage policy tagged to the disk offering in case of VMware", - "name": "vspherestoragepolicy", + "description": "the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "zone", + "type": "string" + }, + { + "description": "the name of the disk offering", + "name": "name", "type": "string" }, { @@ -73531,58 +75145,49 @@ "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": "burst io requests read rate of the disk offering", + "name": "diskIopsReadRateMax", + "type": "long" }, { - "description": "the max iops of the disk offering", - "name": "maxiops", + "description": "burst bytes write rate of the disk offering", + "name": "diskBytesWriteRateMax", "type": "long" }, { - "description": "the storage type for this disk offering", - "name": "storagetype", + "description": "the cache mode to use for this disk offering. none, writeback or writethrough", + "name": "cacheMode", "type": "string" }, { - "description": "bytes write rate of the disk offering", - "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": "io requests write rate of the disk offering", + "name": "diskIopsWriteRate", + "type": "long" }, { - "description": "burst bytes read rate of the disk offering", - "name": "diskBytesReadRateMax", - "type": "long" + "description": "To allow or disallow the resize operation on the disks created from this disk offering, if the flag is true then resize is not allowed", + "name": "disksizestrictness", + "type": "boolean" }, { - "description": "burst bytes write rate of the disk offering", - "name": "diskBytesWriteRateMax", - "type": "long" + "description": "true if disk offering uses custom iops, false otherwise", + "name": "iscustomizediops", + "type": "boolean" }, { "description": "unique ID of the disk offering", "name": "id", "type": "string" }, + {}, { - "description": "length (in seconds) of the burst", - "name": "diskBytesReadRateMaxLength", - "type": "long" - }, - { - "description": "the min iops of the disk offering", - "name": "miniops", - "type": "long" - }, - { - "description": "length (in seconds) of the burst", - "name": "diskIopsWriteRateMaxLength", + "description": "burst io requests write rate of the disk offering", + "name": "diskIopsWriteRateMax", "type": "long" } ] @@ -73593,33 +75198,42 @@ "name": "listVolumes", "params": [ { - "description": "the cluster id the disk volume belongs to", + "description": "list volumes on specified host", "length": 255, - "name": "clusterid", - "related": "addCluster", + "name": "hostid", + "related": "addBaremetalHost,addHost,cancelHostAsDegraded,declareHostAsDegraded,reconnectHost", "required": false, "type": "uuid" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, "name": "listall", "required": false, "type": "boolean" }, { - "description": "state of the volume. Possible values are: Ready, Allocated, Destroy, Expunging, Expunged.", + "description": "the ID of the disk volume", "length": 255, - "name": "state", + "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": "", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "page", + "name": "projectid", + "related": "activateProject,suspendProject,updateProject", "required": false, - "type": "integer" + "type": "uuid" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" }, { "description": "the IDs of the volumes, mutually exclusive with id", @@ -73630,13 +75244,6 @@ "since": "4.9", "type": "list" }, - { - "description": "the type of disk volume", - "length": 255, - "name": "type", - "required": false, - "type": "string" - }, { "description": "list only resources belonging to the domain specified", "length": 255, @@ -73646,43 +75253,35 @@ "type": "uuid" }, { - "description": "list objects by project", + "description": "the cluster id the disk volume belongs to", "length": 255, - "name": "projectid", - "related": "activateProject,suspendProject,updateProject", + "name": "clusterid", + "related": "addCluster", "required": false, "type": "uuid" }, { - "description": "list volumes on specified host", + "description": "the pod id the disk volume belongs to", "length": 255, - "name": "hostid", - "related": "addHost,cancelHostAsDegraded,declareHostAsDegraded,reconnectHost,addBaremetalHost", + "name": "podid", + "related": "updatePod,createManagementNetworkIpRange", "required": false, "type": "uuid" }, { - "description": "the name of the disk volume", - "length": 255, - "name": "name", - "required": false, - "type": "string" - }, - { - "description": "the ID of the storage pool, available to ROOT admin only", + "description": "state of the volume. Possible values are: Ready, Allocated, Destroy, Expunging, Expunged.", "length": 255, - "name": "storageid", - "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool", + "name": "state", "required": false, - "since": "4.3", "type": "string" }, { - "description": "", + "description": "the ID of the availability zone", "length": 255, - "name": "pagesize", + "name": "zoneid", + "related": "createZone,listZones,listZones", "required": false, - "type": "integer" + "type": "uuid" }, { "description": "the ID of the virtual machine", @@ -73692,14 +75291,6 @@ "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": "list resources by account. Must be used with the domainId parameter.", "length": 255, @@ -73708,20 +75299,20 @@ "type": "string" }, { - "description": "the pod id the disk volume belongs to", + "description": "list volumes by disk offering", "length": 255, - "name": "podid", - "related": "updatePod,createManagementNetworkIpRange", + "name": "diskofferingid", + "related": "", "required": false, + "since": "4.4", "type": "uuid" }, { - "description": "the ID of the availability zone", + "description": "the name of the disk volume", "length": 255, - "name": "zoneid", - "related": "createZone,listZones,listZones", + "name": "name", "required": false, - "type": "uuid" + "type": "string" }, { "description": "List resources by tags (key/value pairs)", @@ -73731,93 +75322,87 @@ "type": "map" }, { - "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": "displayvolume", "required": false, + "since": "4.4", "type": "boolean" }, { - "description": "the ID of the disk volume", + "description": "", "length": 255, - "name": "id", - "related": "attachVolume,createVolume,listVolumes,migrateVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "list volumes by disk offering", + "description": "the ID of the storage pool, available to ROOT admin only", "length": 255, - "name": "diskofferingid", - "related": "", + "name": "storageid", + "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool", "required": false, - "since": "4.4", - "type": "uuid" + "since": "4.3", + "type": "string" }, { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "description": "the type of disk volume", + "length": 255, + "name": "type", "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" } ], "related": "attachVolume,createVolume,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": "the bytes actually consumed on disk", - "name": "virtualsize", + "description": "the bytes allocated", + "name": "physicalsize", "type": "long" }, { - "description": "the domain associated with the disk volume", - "name": "domain", - "type": "string" - }, - { - "description": "provisioning type used to create volumes.", - "name": "provisioningtype", + "description": "the path of the volume", + "name": "path", "type": "string" }, { - "description": "the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached.", - "name": "deviceid", - "type": "long" - }, - { - "description": "the boolean state of whether the volume is destroyed or not", - "name": "destroyed", + "description": "need quiesce vm or not when taking snapshot", + "name": "quiescevm", "type": "boolean" }, { - "description": "ID of the snapshot from which this volume was created", - "name": "snapshotid", - "type": "string" + "description": "the date the volume was attached to a VM instance", + "name": "attached", + "type": "date" }, { - "description": "bytes write rate of the disk volume", - "name": "diskBytesWriteRate", + "description": "IO requests read rate of the disk volume per the disk offering", + "name": "diskIopsReadRate", "type": "long" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", - "type": "string" - }, - { - "description": "pod id of the volume", - "name": "podid", + "description": "name of the service offering for root disk", + "name": "serviceofferingname", "type": "string" }, { - "description": "name of the virtual machine", - "name": "vmname", - "type": "string" + "description": "the date the disk volume was created", + "name": "created", + "type": "date" }, { "description": "id of the primary storage hosting the disk volume; returned to admin user only", @@ -73825,83 +75410,33 @@ "type": "string" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", - "type": "string" - }, - { - "description": "display name of the virtual machine", - "name": "vmdisplayname", - "type": "string" - }, - { - "description": "state of the virtual machine", - "name": "vmstate", - "type": "string" - }, - { - "description": "min iops of the disk volume", - "name": "miniops", - "type": "long" - }, - { - "description": "the read (bytes) of disk on the vm", - "name": "diskkbsread", - "type": "long" - }, - { - "description": "pod name of the volume", - "name": "podname", - "type": "string" - }, - { - "description": "need quiesce vm or not when taking snapshot", - "name": "quiescevm", - "type": "boolean" - }, - { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", - "type": "string" - }, - { - "description": "an optional field whether to the display the volume to the end user or not.", - "name": "displayvolume", - "type": "boolean" - }, - { - "description": "type of the disk volume (ROOT or DATADISK)", - "name": "type", - "type": "string" - }, - { - "description": "the disk utilization", - "name": "utilization", + "description": "the ID of the domain associated with the disk volume", + "name": "domainid", "type": "string" }, { - "description": "the display text of the disk offering", - "name": "diskofferingdisplaytext", + "description": "the account associated with the disk volume", + "name": "account", "type": "string" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "name of the availability zone", + "name": "zonename", "type": "string" }, { - "description": "ID of the disk offering", - "name": "diskofferingid", + "description": "name of the disk offering", + "name": "diskofferingname", "type": "string" }, { - "description": "the account associated with the disk volume", - "name": "account", + "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": "max iops of the disk volume", + "name": "maxiops", "type": "long" }, { @@ -73909,144 +75444,98 @@ "name": "virtualmachineid", "type": "string" }, - { - "description": "bytes read rate of the disk volume", - "name": "diskBytesReadRate", - "type": "long" - }, - { - "description": "the date the volume was attached to a VM instance", - "name": "attached", - "type": "date" - }, - { - "description": "true if the volume is extractable, false otherwise", - "name": "isextractable", - "type": "boolean" - }, - { - "description": "ID of the disk volume", - "name": "id", - "type": "string" - }, - { - "description": "name of the availability zone", - "name": "zonename", - "type": "string" - }, { "description": "name of the primary storage hosting the disk volume", "name": "storage", "type": "string" }, - { - "description": "ID of the availability zone", - "name": "zoneid", - "type": "string" - }, - { - "description": "ID of the service offering for root disk", - "name": "serviceofferingid", - "type": "string" - }, - { - "description": "cluster name where the volume is allocated", - "name": "clustername", - "type": "string" - }, { "description": "the name of the template for the virtual machine", "name": "templatename", "type": "string" }, { - "description": "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 ID of the domain associated with the disk volume", - "name": "domainid", + "description": "type of the disk volume (ROOT or DATADISK)", + "name": "type", "type": "string" }, { - "description": "the project id of the vpn", - "name": "projectid", + "description": "cluster name where the volume is allocated", + "name": "clustername", "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": "max iops of the disk volume", - "name": "maxiops", + "description": "the write (IO) of disk on the vm", + "name": "diskiowrite", "type": "long" }, { - "description": "name of the service offering for root disk", - "name": "serviceofferingname", + "description": "name of the virtual machine", + "name": "vmname", "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": "shared or local storage", - "name": "storagetype", + "description": "pod name of the volume", + "name": "podname", "type": "string" }, { - "description": "name of the disk volume", - "name": "name", + "description": "the display text of the service offering for root disk", + "name": "serviceofferingdisplaytext", "type": "string" }, { - "description": "cluster id of the volume", - "name": "clusterid", + "description": "IO requests write rate of the disk volume per the disk offering", + "name": "diskIopsWriteRate", + "type": "long" + }, + { + "description": "ID of the service offering for root disk", + "name": "serviceofferingid", "type": "string" }, { - "description": "the date the disk volume was created", - "name": "created", - "type": "date" + "description": "bytes read rate of the disk volume", + "name": "diskBytesReadRate", + "type": "long" }, { - "description": "the status of the volume", - "name": "status", + "description": "state of the virtual machine", + "name": "vmstate", "type": "string" }, { - "description": "the write (bytes) of disk on the vm", - "name": "diskkbswrite", + "description": "the bytes actually consumed on disk", + "name": "virtualsize", "type": "long" }, { - "description": "the write (io) of disk on the vm", - "name": "diskiowrite", - "type": "long" + "description": "ID of the snapshot from which this volume was created", + "name": "snapshotid", + "type": "string" }, { "description": "the list of resource tags associated", "name": "tags", "response": [ { - "description": "resource type", - "name": "resourcetype", + "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" }, { @@ -74055,28 +75544,23 @@ "type": "string" }, { - "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": "tag key name", - "name": "key", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { @@ -74088,54 +75572,130 @@ "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": "size of the disk volume", - "name": "size", + "description": "cluster id of the volume", + "name": "clusterid", + "type": "string" + }, + { + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", "type": "long" }, { - "description": "io requests read rate of the disk volume per the disk offering", - "name": "diskIopsReadRate", + "description": "Hypervisor the volume belongs to", + "name": "hypervisor", + "type": "string" + }, + { + "description": "provisioning type used to create volumes.", + "name": "provisioningtype", + "type": "string" + }, + { + "description": "ID of the disk offering", + "name": "diskofferingid", + "type": "string" + }, + { + "description": "pod id of the volume", + "name": "podid", + "type": "string" + }, + { + "description": "min iops of the disk volume", + "name": "miniops", "type": "long" }, { - "description": "the state of the disk volume", - "name": "state", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { - "description": "true if storage snapshot is supported for the volume, false otherwise", - "name": "supportsstoragesnapshot", - "type": "boolean" + "description": "the project id of the vpn", + "name": "projectid", + "type": "string" }, { - "description": "name of the disk offering", - "name": "diskofferingname", + "description": "bytes write rate of the disk volume", + "name": "diskBytesWriteRate", + "type": "long" + }, + { + "description": "volume uuid that is given by virtualisation provider (only for VMware)", + "name": "externaluuid", + "type": "string" + }, + { + "description": "the display text of the disk offering", + "name": "diskofferingdisplaytext", + "type": "string" + }, + {}, + { + "description": "the disk utilization", + "name": "utilization", "type": "string" }, + { + "description": "size of the disk volume", + "name": "size", + "type": "long" + }, + { + "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 chain info of the volume", - "name": "chaininfo", + "description": "the domain associated with the disk volume", + "name": "domain", "type": "string" }, - {}, { - "description": "the path of the volume", - "name": "path", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the bytes allocated", - "name": "physicalsize", + "description": "true if the volume is extractable, false otherwise", + "name": "isextractable", + "type": "boolean" + }, + { + "description": "true if storage snapshot is supported for the volume, false otherwise", + "name": "supportsstoragesnapshot", + "type": "boolean" + }, + { + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", + "type": "string" + }, + { + "description": "the chain info of the volume", + "name": "chaininfo", + "type": "string" + }, + { + "description": "the read (IO) of disk on the vm", + "name": "diskioread", "type": "long" }, { @@ -74144,9 +75704,59 @@ "type": "string" }, { - "description": "the display text of the service offering for root disk", - "name": "serviceofferingdisplaytext", + "description": "name of the disk volume", + "name": "name", + "type": "string" + }, + { + "description": "display name of the virtual machine", + "name": "vmdisplayname", + "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": "shared or local storage", + "name": "storagetype", + "type": "string" + }, + { + "description": "the boolean state of whether the volume is destroyed or not", + "name": "destroyed", + "type": "boolean" + }, + { + "description": "the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached.", + "name": "deviceid", + "type": "long" + }, + { + "description": "the status of the volume", + "name": "status", + "type": "string" + }, + { + "description": "ID of the disk volume", + "name": "id", + "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 volume to the end user or not.", + "name": "displayvolume", + "type": "boolean" } ] }, @@ -74156,53 +75766,53 @@ "name": "createLBHealthCheckPolicy", "params": [ { - "description": "an optional field, whether to the display the rule to the end user or not", + "description": "the ID of the load balancer rule", "length": 255, - "name": "fordisplay", - "required": false, - "since": "4.4", - "type": "boolean" + "name": "lbruleid", + "related": "updateIpv6FirewallRule", + "required": true, + "type": "uuid" }, { - "description": "Number of consecutive health check success before declaring an instance healthy", + "description": "Time to wait when receiving a response from the health check (2sec - 60 sec)", "length": 255, - "name": "healthythreshold", + "name": "responsetimeout", "required": false, "type": "integer" }, { - "description": "the ID of the load balancer rule", + "description": "the description of the load balancer health check policy", "length": 255, - "name": "lbruleid", - "related": "", - "required": true, - "type": "uuid" + "name": "description", + "required": false, + "type": "string" }, { - "description": "the description of the load balancer health check policy", + "description": "HTTP ping path", "length": 255, - "name": "description", + "name": "pingpath", "required": false, "type": "string" }, { - "description": "Number of consecutive health check failures before declaring an instance unhealthy", + "description": "Number of consecutive health check success before declaring an instance healthy", "length": 255, - "name": "unhealthythreshold", + "name": "healthythreshold", "required": false, "type": "integer" }, { - "description": "HTTP ping path", + "description": "an optional field, whether to the display the rule to the end user or not", "length": 255, - "name": "pingpath", + "name": "fordisplay", "required": false, - "type": "string" + "since": "4.4", + "type": "boolean" }, { - "description": "Time to wait when receiving a response from the health check (2sec - 60 sec)", + "description": "Number of consecutive health check failures before declaring an instance unhealthy", "length": 255, - "name": "responsetimeout", + "name": "unhealthythreshold", "required": false, "type": "integer" }, @@ -74216,52 +75826,20 @@ ], "related": "listLBHealthCheckPolicies", "response": [ - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the account of the HealthCheck policy", - "name": "account", - "type": "string" - }, - { - "description": "the id of the zone the HealthCheck policy belongs to", - "name": "zoneid", - "type": "string" - }, - {}, { "description": "the list of healthcheckpolicies", "name": "healthcheckpolicy", "response": [ { - "description": "Number of consecutive health check failures before declaring an instance unhealthy.", - "name": "unhealthcheckthresshold", - "type": "int" + "description": "the state of the policy", + "name": "state", + "type": "string" }, { "description": "is policy for display to the regular user", "name": "fordisplay", "type": "boolean" }, - { - "description": "Time to wait when receiving a response from the health check", - "name": "responsetime", - "type": "int" - }, - { - "description": "the description of the healthcheck policy", - "name": "description", - "type": "string" - }, - { - "description": "Number of consecutive health check success before declaring an instance healthy", - "name": "healthcheckthresshold", - "type": "int" - }, { "description": "Amount of time between health checks", "name": "healthcheckinterval", @@ -74278,33 +75856,65 @@ "type": "string" }, { - "description": "the state of the policy", - "name": "state", + "description": "Number of consecutive health check failures before declaring an instance unhealthy.", + "name": "unhealthcheckthresshold", + "type": "int" + }, + { + "description": "Time to wait when receiving a response from the health check", + "name": "responsetime", + "type": "int" + }, + { + "description": "Number of consecutive health check success before declaring an instance healthy", + "name": "healthcheckthresshold", + "type": "int" + }, + { + "description": "the description of the healthcheck policy", + "name": "description", "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 HealthCheck policy", - "name": "domainid", + "description": "the account of the HealthCheck policy", + "name": "account", "type": "string" }, + {}, { "description": "the domain of the HealthCheck policy", "name": "domain", "type": "string" - } + }, + { + "description": "the domain ID of the HealthCheck policy", + "name": "domainid", + "type": "string" + }, + { + "description": "the id of the zone the HealthCheck policy belongs to", + "name": "zoneid", + "type": "string" + }, + { + "description": "the LB rule ID", + "name": "lbruleid", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + {} ], "since": "4.2.0" }, @@ -74325,52 +75935,36 @@ "related": "createUser,disableUser,enableUser,getUser,listUsers,updateUser", "response": [ { - "description": "the date and time the user account was created", - "name": "created", - "type": "date" - }, - {}, - { - "description": "the timezone user was created in", - "name": "timezone", - "type": "string" - }, - { - "description": "the source type of the user in lowercase, such as native, ldap, saml2", - "name": "usersource", + "description": "the user name", + "name": "username", "type": "string" }, { - "description": "the api key of the user", - "name": "apikey", + "description": "the name of the role", + "name": "rolename", "type": "string" }, { - "description": "the secret key of the user", - "name": "secretkey", + "description": "the ID of the role", + "name": "roleid", "type": "string" }, - {}, - { - "description": "true if user is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, { - "description": "the user ID", - "name": "id", + "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 date and time the user account was created", + "name": "created", + "type": "date" }, { - "description": "the type of the role", - "name": "roletype", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, { "description": "the user firstname", "name": "firstname", @@ -74379,26 +75973,31 @@ { "description": "the account type of the user", "name": "accounttype", - "type": "short" + "type": "integer" }, { - "description": "the user name", - "name": "username", - "type": "string" + "description": "the boolean value representing if the updating target is in caller's child domain", + "name": "iscallerchilddomain", + "type": "boolean" }, { - "description": "the account ID of the user", - "name": "accountid", + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the secret key of the user", + "name": "secretkey", "type": "string" }, { - "description": "the domain name of the user", - "name": "domain", + "description": "the user ID", + "name": "id", "type": "string" }, { - "description": "the name of the role", - "name": "rolename", + "description": "the user email address", + "name": "email", "type": "string" }, { @@ -74407,28 +76006,29 @@ "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the timezone user was created in", + "name": "timezone", "type": "string" }, { - "description": "the boolean value representing if the updating target is in caller's child domain", - "name": "iscallerchilddomain", - "type": "boolean" + "description": "the user state", + "name": "state", + "type": "string" }, + {}, { - "description": "the domain ID of the user", - "name": "domainid", - "type": "string" + "description": "true if user is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "the user state", - "name": "state", + "description": "the domain name of the user", + "name": "domain", "type": "string" }, { - "description": "the ID of the role", - "name": "roleid", + "description": "the api key of the user", + "name": "apikey", "type": "string" }, { @@ -74436,14 +76036,24 @@ "name": "jobstatus", "type": "integer" }, + { + "description": "the account ID of the user", + "name": "accountid", + "type": "string" + }, + { + "description": "the source type of the user in lowercase, such as native, ldap, saml2", + "name": "usersource", + "type": "string" + }, { "description": "the account name of the user", "name": "account", "type": "string" }, { - "description": "the user email address", - "name": "email", + "description": "the type of the role", + "name": "roletype", "type": "string" } ] @@ -74455,6 +76065,17 @@ "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", @@ -74465,17 +76086,6 @@ "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" - }, - {}, - { - "description": "the Cloudian Management Console base URL", - "name": "url", - "type": "string" - }, - { - "description": "the Cloudian connector enabled state", - "name": "enabled", - "type": "boolean" } ], "since": "4.11.0" @@ -74486,19 +76096,11 @@ "name": "listLBHealthCheckPolicies", "params": [ { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - }, - { - "description": "the ID of the load balancer rule", + "description": "", "length": 255, - "name": "lbruleid", - "related": "", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" }, { "description": "the ID of the health check policy", @@ -74510,11 +76112,11 @@ "type": "uuid" }, { - "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", @@ -74524,6 +76126,14 @@ "since": "4.4", "type": "boolean" }, + { + "description": "the ID of the load balancer rule", + "length": 255, + "name": "lbruleid", + "related": "updateIpv6FirewallRule", + "required": false, + "type": "uuid" + }, { "description": "", "length": 255, @@ -74535,8 +76145,8 @@ "related": "", "response": [ { - "description": "the id of the zone the HealthCheck policy belongs to", - "name": "zoneid", + "description": "the account of the HealthCheck policy", + "name": "account", "type": "string" }, { @@ -74544,24 +76154,24 @@ "name": "healthcheckpolicy", "response": [ { - "description": "Time to wait when receiving a response from the health check", - "name": "responsetime", - "type": "int" + "description": "the state of the policy", + "name": "state", + "type": "string" }, { - "description": "Number of consecutive health check success before declaring an instance healthy", - "name": "healthcheckthresshold", + "description": "Amount of time between health checks", + "name": "healthcheckinterval", "type": "int" }, { - "description": "the pingpath of the healthcheck policy", - "name": "pingpath", + "description": "the LB HealthCheck policy ID", + "name": "id", "type": "string" }, { - "description": "the description of the healthcheck policy", - "name": "description", - "type": "string" + "description": "Number of consecutive health check failures before declaring an instance unhealthy.", + "name": "unhealthcheckthresshold", + "type": "int" }, { "description": "is policy for display to the regular user", @@ -74569,60 +76179,60 @@ "type": "boolean" }, { - "description": "the LB HealthCheck policy ID", - "name": "id", + "description": "the description of the healthcheck policy", + "name": "description", "type": "string" }, { - "description": "Amount of time between health checks", - "name": "healthcheckinterval", - "type": "int" + "description": "the pingpath of the healthcheck policy", + "name": "pingpath", + "type": "string" }, { - "description": "Number of consecutive health check failures before declaring an instance unhealthy.", - "name": "unhealthcheckthresshold", + "description": "Number of consecutive health check success before declaring an instance healthy", + "name": "healthcheckthresshold", "type": "int" }, { - "description": "the state of the policy", - "name": "state", - "type": "string" + "description": "Time to wait when receiving a response from the health check", + "name": "responsetime", + "type": "int" } ], "type": "list" }, { - "description": "the account of the HealthCheck policy", - "name": "account", + "description": "the LB rule ID", + "name": "lbruleid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the 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 domain of the HealthCheck policy", - "name": "domain", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {}, { - "description": "the LB rule ID", - "name": "lbruleid", + "description": "the id of the zone the HealthCheck policy belongs to", + "name": "zoneid", "type": "string" }, + {}, { "description": "the domain ID of the HealthCheck policy", "name": "domainid", "type": "string" - }, - {} + } ], "since": "4.2.0" }, @@ -74632,109 +76242,92 @@ "name": "createNetwork", "params": [ { - "description": "account that will own the network", - "length": 255, - "name": "account", - "required": false, - "type": "string" - }, - { - "description": "network domain", + "description": "the CIDR of IPv6 network, must be at least /64", "length": 255, - "name": "networkdomain", + "name": "ip6cidr", "required": false, "type": "string" }, { - "description": "Network ACL ID associated for the network", + "description": "the network offering ID", "length": 255, - "name": "aclid", - "related": "createNetworkACLList", - "required": false, + "name": "networkofferingid", + "related": "listNetworkOfferings", + "required": true, "type": "uuid" }, { - "description": "the gateway of the IPv6 network. Required for Shared networks", + "description": "IPV6 address to be assigned to a router in a shared network", "length": 255, - "name": "ip6gateway", + "name": "routeripv6", "required": false, + "since": "4.16", "type": "string" }, { - "description": "the physical network ID the network belongs to", + "description": "when true bypasses VLAN id/range overlap check during network creation for shared and L2 networks", "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork", + "name": "bypassvlanoverlapcheck", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "the VPC network belongs to", + "description": "the beginning IPv6 address in the IPv6 network range", "length": 255, - "name": "vpcid", - "related": "listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", + "name": "startipv6", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "the isolated private VLAN type for this network", + "description": "the display text of the network", "length": 255, - "name": "isolatedpvlantype", - "required": false, + "name": "displaytext", + "required": true, "type": "string" }, { - "description": "the network offering ID", + "description": "the zone ID for the network", "length": 255, - "name": "networkofferingid", - "related": "listNetworkOfferings", + "name": "zoneid", + "related": "createZone,listZones,listZones", "required": true, "type": "uuid" }, { - "description": "Defines whether to allow subdomains to use networks dedicated to their parent domain(s). Should be used with aclType=Domain, defaulted to allow.subdomain.network.access global config if not specified", - "length": 255, - "name": "subdomainaccess", - "required": false, - "type": "boolean" - }, - { - "description": "IPV6 address to be assigned to a router in a shared network", + "description": "the beginning IP address in the network IP range", "length": 255, - "name": "routeripv6", + "name": "startip", "required": false, - "since": "4.16", "type": "string" }, { - "description": "an optional project for the SSH key", + "description": "network domain", "length": 255, - "name": "projectid", - "related": "activateProject,suspendProject,updateProject", + "name": "networkdomain", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "IPV4 address to be assigned to a router in a shared network", + "description": "the gateway of the IPv6 network. Required for Shared networks", "length": 255, - "name": "routerip", + "name": "ip6gateway", "required": false, - "since": "4.16", "type": "string" }, { - "description": "the name of the network", + "description": "account that will own the network", "length": 255, - "name": "name", - "required": true, + "name": "account", + "required": false, "type": "string" }, { - "description": "domain ID of the account owning a network", + "description": "The network this network is associated to. only available if create a Shared network", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", + "name": "associatednetworkid", + "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listBrocadeVcsDeviceNetworks", "required": false, + "since": "4.17.0", "type": "uuid" }, { @@ -74745,30 +76338,30 @@ "type": "boolean" }, { - "description": "Access control type; supported values are account and domain. In 3.0 all shared networks should have aclType=Domain, and all isolated networks - Account. Account means that only the account owner can use the network, domain - all accounts in the domain can use the network", + "description": "the isolated private VLAN for this network", "length": 255, - "name": "acltype", + "name": "isolatedpvlan", "required": false, "type": "string" }, { - "description": "the isolated private VLAN for this network", + "description": "the isolated private VLAN type for this network", "length": 255, - "name": "isolatedpvlan", + "name": "isolatedpvlantype", "required": false, "type": "string" }, { - "description": "the ending IP address in the network IP range. If not specified, will be defaulted to startIP", + "description": "ID of the network in an external system.", "length": 255, - "name": "endip", + "name": "externalid", "required": false, "type": "string" }, { - "description": "the display text of the network", + "description": "the name of the network", "length": 255, - "name": "displaytext", + "name": "name", "required": true, "type": "string" }, @@ -74780,133 +76373,164 @@ "type": "string" }, { - "description": "when true ip address usage for the network will not be exported by the listUsageRecords API", + "description": "the gateway of the network. Required for shared networks and isolated networks when it belongs to VPC", "length": 255, - "name": "hideipaddressusage", + "name": "gateway", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "the CIDR of IPv6 network, must be at least /64", + "description": "the physical network ID the network belongs to", "length": 255, - "name": "ip6cidr", + "name": "physicalnetworkid", + "related": "createPhysicalNetwork", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "the beginning IPv6 address in the IPv6 network range", + "description": "domain ID of the account owning a network", "length": 255, - "name": "startipv6", + "name": "domainid", + "related": "listDomainChildren,listDomains", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "the gateway of the network. Required for shared networks and isolated networks when it belongs to VPC", + "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": "gateway", + "name": "acltype", "required": false, "type": "string" }, { - "description": "the beginning IP address in the network IP range", + "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": "startip", + "name": "subdomainaccess", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "the ID or VID of the network", + "description": "the ending IPv6 address in the IPv6 network range", "length": 255, - "name": "vlan", + "name": "endipv6", "required": false, "type": "string" }, { - "description": "the ending IPv6 address in the IPv6 network range", + "description": "an optional project for the network", "length": 255, - "name": "endipv6", + "name": "projectid", + "related": "activateProject,suspendProject,updateProject", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "when true bypasses VLAN id/range overlap check during network creation for shared and L2 networks", + "description": "Network ACL ID associated for the network", "length": 255, - "name": "bypassvlanoverlapcheck", + "name": "aclid", + "related": "createNetworkACLList", + "required": false, + "type": "uuid" + }, + { + "description": "when true ip address usage for the network will not be exported by the listUsageRecords API", + "length": 255, + "name": "hideipaddressusage", "required": false, "type": "boolean" }, { - "description": "ID of the network in an external system.", + "description": "the ending IP address in the network IP range. If not specified, will be defaulted to startIP", "length": 255, - "name": "externalid", + "name": "endip", "required": false, "type": "string" }, { - "description": "the zone ID for the network", + "description": "IPV4 address to be assigned to a router in a shared network", "length": 255, - "name": "zoneid", - "related": "createZone,listZones,listZones", - "required": true, + "name": "routerip", + "required": false, + "since": "4.16", + "type": "string" + }, + { + "description": "the VPC network belongs to", + "length": 255, + "name": "vpcid", + "related": "listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", + "required": false, "type": "uuid" + }, + { + "description": "the ID or VID of the network", + "length": 255, + "name": "vlan", + "required": false, + "type": "string" } ], - "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork,listF5LoadBalancerNetworks,listNetscalerLoadBalancerNetworks,listBrocadeVcsDeviceNetworks", + "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listBrocadeVcsDeviceNetworks", "response": [ { - "description": "availability of the network offering the network is created from", - "name": "networkofferingavailability", + "description": "zone id of the network", + "name": "zoneid", "type": "string" }, - {}, { - "description": "VPC the network belongs to", - "name": "vpcid", - "type": "string" + "description": "true if network supports specifying ip ranges, false otherwise", + "name": "specifyipranges", + "type": "boolean" }, { - "description": "the type of the network", - "name": "type", + "description": "the first DNS for the network", + "name": "dns1", "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 details of the network", + "name": "details", + "type": "map" + }, + { + "description": "related to what other network configuration", + "name": "related", "type": "string" }, { - "description": "the date this network was created", - "name": "created", - "type": "date" + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" }, { - "description": "the displaytext of the network", - "name": "displaytext", + "description": "the owner of the network", + "name": "account", "type": "string" }, + {}, { - "description": "display text of the network offering the network is created from", - "name": "networkofferingdisplaytext", + "description": "the second DNS for the network", + "name": "dns2", "type": "string" }, { - "description": "the details of the network", - "name": "details", - "type": "map" + "description": "the network's netmask", + "name": "netmask", + "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" + "description": "an optional field, whether to the display the network to the end user or not.", + "name": "displaynetwork", + "type": "boolean" }, { - "description": "the network's netmask", - "name": "netmask", + "description": "network offering id the network is created from", + "name": "networkofferingid", "type": "string" }, { - "description": "acl type - access type to the network", - "name": "acltype", + "description": "state of the network", + "name": "state", "type": "string" }, { @@ -74915,19 +76539,19 @@ "type": "string" }, { - "description": "the owner of the network", - "name": "account", - "type": "string" + "description": "the date this network was created", + "name": "created", + "type": "date" }, { - "description": "ACL Id associated with the VPC network", - "name": "aclid", + "description": "the name of the network", + "name": "name", "type": "string" }, { - "description": "true network requires restart", - "name": "restartrequired", - "type": "boolean" + "description": "the network CIDR of the guest network configured with IP reservation. It is the summation of CIDR and RESERVED_IP_RANGE", + "name": "networkcidr", + "type": "string" }, { "description": "the project name of the address", @@ -74935,18 +76559,33 @@ "type": "string" }, { - "description": "the name of the zone the network belongs to", - "name": "zonename", + "description": "ACL name associated with the VPC network", + "name": "aclname", + "type": "string" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, + { + "description": "list networks available for vm deployment", + "name": "canusefordeploy", + "type": "boolean" + }, { "description": "Base64 string representation of the resource icon", "name": "icon", "type": "resourceiconresponse" }, { - "description": "The external id of the network", - "name": "externalid", + "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": "ACL Id associated with the VPC network", + "name": "aclid", "type": "string" }, { @@ -74955,63 +76594,205 @@ "type": "boolean" }, { - "description": "broadcast uri of the network. This parameter is visible to ROOT admins only", - "name": "broadcasturi", + "description": "the id of the network", + "name": "id", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "The internet protocol of network offering", + "name": "internetprotocol", "type": "string" }, { - "description": "related to what other network configuration", - "name": "related", + "description": "The external id of the network", + "name": "externalid", "type": "string" }, { - "description": "list networks available for vm deployment", - "name": "canusefordeploy", - "type": "boolean" + "description": "the physical network id", + "name": "physicalnetworkid", + "type": "string" }, { - "description": "Name of the VPC to which this network belongs", - "name": "vpcname", + "description": "VPC the network belongs to", + "name": "vpcid", "type": "string" }, { - "description": "the first DNS for the network", - "name": "dns1", + "description": "the network domain", + "name": "networkdomain", + "type": "string" + }, + { + "description": "the displaytext of the network", + "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": "true if network can span multiple zones", + "name": "strechedl2subnet", + "type": "boolean" + }, + { + "description": "true if network is system, false otherwise", + "name": "issystem", + "type": "boolean" + }, { "description": "name of the network offering the network is created from", "name": "networkofferingname", "type": "string" }, { - "description": "an optional field, whether to the display the network to the end user or not.", - "name": "displaynetwork", + "description": "the domain id of the network owner", + "name": "domainid", + "type": "string" + }, + { + "description": "The routing mode of network offering", + "name": "ip6routing", + "type": "string" + }, + { + "description": "the name of the zone the network belongs to", + "name": "zonename", + "type": "string" + }, + { + "description": "If a network is enabled for 'streched l2 subnet' then represents zones on which network currently spans", + "name": "zonesnetworkspans", + "type": "set" + }, + { + "description": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR", + "name": "cidr", + "type": "string" + }, + { + "description": "the project id of the ipaddress", + "name": "projectid", + "type": "string" + }, + { + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" + }, + { + "description": "the name of the Network associated with this private gateway", + "name": "associatednetwork", + "type": "string" + }, + { + "description": "broadcast uri of the network. This parameter is visible to ROOT admins only", + "name": "broadcasturi", + "type": "string" + }, + { + "description": "true network requires restart", + "name": "restartrequired", "type": "boolean" }, { - "description": "If the network has redundant routers enabled", - "name": "redundantrouter", + "description": "Name of the VPC to which this network belongs", + "name": "vpcname", + "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 current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "Broadcast domain type of the network", + "name": "broadcastdomaintype", + "type": "string" + }, + { + "description": "the list of 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": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "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" + } + ], + "type": "list" + }, + { + "description": "the name of the Network associated with this network", + "name": "associatednetwork", "type": "string" }, { - "description": "true if network is system, false otherwise", - "name": "issystem", + "description": "list networks that are persistent", + "name": "ispersistent", "type": "boolean" }, { - "description": "true if network offering is ip conserve mode enabled", - "name": "networkofferingconservemode", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { @@ -75020,59 +76801,51 @@ "type": "string" }, { - "description": "zone id of the network", - "name": "zoneid", - "type": "string" - }, - { - "description": "true if network is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "Broadcast domain type of the network", - "name": "broadcastdomaintype", + "description": "the ID of the Network associated with this network", + "name": "associatednetworkid", "type": "string" }, {}, { - "description": "the id of the network", - "name": "id", + "description": "the network's gateway", + "name": "gateway", "type": "string" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "If the network has redundant routers enabled", + "name": "redundantrouter", + "type": "boolean" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "The vlan of the network. This parameter is visible to ROOT admins only", + "name": "vlan", "type": "string" }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, { "description": "the list of services", "name": "service", "response": [ { - "description": "the service name", - "name": "name", - "type": "string" + "description": "the list of capabilities", + "name": "capability", + "response": [ + { + "description": "the capability value", + "name": "value", + "type": "string" + }, + { + "description": "can this service capability value can be choosable while creatine network offerings", + "name": "canchooseservicecapability", + "type": "boolean" + }, + { + "description": "the capability name", + "name": "name", + "type": "string" + } + ], + "type": "list" }, { "description": "the service provider name", @@ -75084,18 +76857,13 @@ "type": "list" }, { - "description": "the destination physical network", - "name": "destinationphysicalnetworkid", - "type": "string" - }, - { - "description": "the provider name", - "name": "name", + "description": "the physical network this belongs to", + "name": "physicalnetworkid", "type": "string" }, { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", + "description": "state of the network provider", + "name": "state", "type": "string" }, { @@ -75104,178 +76872,69 @@ "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" - } - ], - "type": "list" - }, - { - "description": "the list of capabilities", - "name": "capability", - "response": [ - { - "description": "the capability name", - "name": "name", + "description": "the destination physical network", + "name": "destinationphysicalnetworkid", "type": "string" }, { - "description": "the capability value", - "name": "value", + "description": "the provider name", + "name": "name", "type": "string" }, { - "description": "can this service capability value can be choosable while creatine network offerings", - "name": "canchooseservicecapability", + "description": "true if individual services can be enabled/disabled", + "name": "canenableindividualservice", "type": "boolean" } ], "type": "list" + }, + { + "description": "the service name", + "name": "name", + "type": "string" } ], "type": "list" }, { - "description": "true if network supports specifying ip ranges, false otherwise", - "name": "specifyipranges", - "type": "boolean" - }, - { - "description": "state of the network", - "name": "state", + "description": "acl type - access type to the network", + "name": "acltype", "type": "string" }, { - "description": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR", - "name": "cidr", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "list networks that are persistent", - "name": "ispersistent", - "type": "boolean" - }, - { - "description": "the network domain", - "name": "networkdomain", + "description": "display text of the network offering the network is created from", + "name": "networkofferingdisplaytext", "type": "string" }, { - "description": "ACL name associated with the VPC network", - "name": "aclname", + "description": "availability of the network offering the network is created from", + "name": "networkofferingavailability", "type": "string" }, { - "description": "the physical network id", - "name": "physicalnetworkid", + "description": "the ID of the Network associated with this private gateway", + "name": "associatednetworkid", "type": "string" }, { - "description": "If a network is enabled for 'streched l2 subnet' then represents zones on which network currently spans", - "name": "zonesnetworkspans", + "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": "true if network can span multiple zones", - "name": "strechedl2subnet", + "description": "true if network is default, false otherwise", + "name": "isdefault", "type": "boolean" }, { - "description": "the name of the network", - "name": "name", - "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 id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - } - ], - "type": "list" - }, - { - "description": "the second DNS for the network", - "name": "dns2", - "type": "string" - }, - { - "description": "the network's gateway", - "name": "gateway", - "type": "string" - }, - { - "description": "The vlan of the network. This parameter is visible to ROOT admins only", - "name": "vlan", - "type": "string" - }, - { - "description": "the domain id of the network owner", - "name": "domainid", - "type": "string" - }, - { - "description": "the network CIDR of the guest network configured with IP reservation. It is the summation of CIDR and RESERVED_IP_RANGE", - "name": "networkcidr", + "description": "the type of the network", + "name": "type", "type": "string" } ] @@ -75286,85 +76945,75 @@ "name": "listNetworkOfferings", "params": [ { - "description": "the availability of network offering. Default value is required", + "description": "list by traffic type", "length": 255, - "name": "availability", + "name": "traffictype", "required": false, "type": "string" }, { - "description": "list network offerings by ID", + "description": "true if offering has tags specified", "length": 255, - "name": "id", - "related": "listNetworkOfferings", + "name": "istagged", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "the ID of the network. Pass this in if you want to see the available network offering that a network can be changed to.", + "description": "list network offerings by name", "length": 255, - "name": "networkid", - "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork,listF5LoadBalancerNetworks,listNetscalerLoadBalancerNetworks,listBrocadeVcsDeviceNetworks", + "name": "name", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "list network offerings available for network creation in specific domain", + "description": "list network offerings supporting certain services", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", + "name": "supportedservices", "required": false, - "since": "4.13", - "type": "uuid" + "type": "list" }, { - "description": "list network offerings by state", + "description": "true if need to list only default network offerings. Default value is false", "length": 255, - "name": "state", + "name": "isdefault", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "List by keyword", + "description": "list network offerings by display text", "length": 255, - "name": "keyword", + "name": "displaytext", "required": false, "type": "string" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, - { - "description": "the tags for the network offering.", + "description": "true if need to list only netwok offerings where source NAT is supported, false otherwise", "length": 255, - "name": "specifyvlan", + "name": "sourcenatsupported", "required": false, "type": "boolean" }, { - "description": "list by traffic type", + "description": "List by keyword", "length": 255, - "name": "traffictype", + "name": "keyword", "required": false, "type": "string" }, { - "description": "", + "description": "list network offerings by ID", "length": 255, - "name": "pagesize", + "name": "id", + "related": "listNetworkOfferings", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "true if need to list only default network offerings. Default value is false", + "description": "", "length": 255, - "name": "isdefault", + "name": "page", "required": false, - "type": "boolean" + "type": "integer" }, { "description": "the network offering can be used only for network creation inside the VPC", @@ -75374,85 +77023,90 @@ "type": "boolean" }, { - "description": "true if offering has tags specified", + "description": "list network offerings by state", "length": 255, - "name": "istagged", + "name": "state", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "list network offerings by name", + "description": "true if need to list only network offerings which support specifying ip ranges", "length": 255, - "name": "name", + "name": "specifyipranges", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "list network offerings by tags", - "length": 4096, - "name": "tags", + "description": "the availability of network offering. Default value is required", + "length": 255, + "name": "availability", "required": false, "type": "string" }, { - "description": "list network offerings by guest type: shared or isolated", + "description": "list network offerings available for network creation in specific domain", "length": 255, - "name": "guestiptype", + "name": "domainid", + "related": "listDomainChildren,listDomains", "required": false, - "type": "string" + "since": "4.13", + "type": "uuid" }, { - "description": "list network offerings available for network creation in specific zone", + "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": "zoneid", - "related": "createZone,listZones,listZones", + "name": "networkid", + "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listBrocadeVcsDeviceNetworks", "required": false, "type": "uuid" }, { - "description": "true if need to list only network offerings which support specifying ip ranges", + "description": "the tags for the network offering.", "length": 255, - "name": "specifyipranges", + "name": "specifyvlan", "required": false, "type": "boolean" }, { - "description": "list network offerings by display text", + "description": "list network offerings by guest type: shared or isolated", "length": 255, - "name": "displaytext", + "name": "guestiptype", "required": false, "type": "string" }, { - "description": "true if need to list only netwok offerings where source NAT is supported, false otherwise", + "description": "", "length": 255, - "name": "sourcenatsupported", + "name": "pagesize", "required": false, - "type": "boolean" + "type": "integer" }, { - "description": "list network offerings supporting certain services", + "description": "list network offerings by tags", + "length": 4096, + "name": "tags", + "required": false, + "type": "string" + }, + { + "description": "list network offerings available for network creation in specific zone", "length": 255, - "name": "supportedservices", + "name": "zoneid", + "related": "createZone,listZones,listZones", "required": false, - "type": "list" + "type": "uuid" } ], "related": "", "response": [ { - "description": "the date this network offering was created", - "name": "created", - "type": "date" - }, - { - "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" }, { - "description": "true if network offering can be used by VPC networks only", - "name": "forvpc", + "description": "true if network offering is default, false otherwise", + "name": "isdefault", "type": "boolean" }, { @@ -75460,99 +77114,35 @@ "name": "domain", "type": "string" }, - { - "description": "data transfer rate in megabits per second allowed.", - "name": "networkrate", - "type": "integer" - }, - { - "description": "the traffic type for the network offering, supported types are Public, Management, Control, Guest, Vlan or Storage.", - "name": "traffictype", - "type": "string" - }, - { - "description": "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": "true if network offering supports persistent networks, false otherwise", "name": "ispersistent", "type": "boolean" }, + {}, + {}, { - "description": "true if network offering supports vlans, false otherwise", - "name": "specifyvlan", - "type": "boolean" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the ID of the service offering used by virtual router provider", - "name": "serviceofferingid", - "type": "string" - }, - { - "description": "true if network offering supports specifying ip ranges, false otherwise", - "name": "specifyipranges", - "type": "boolean" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "true if network offering is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "an alternate display text of the network offering.", - "name": "displaytext", - "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 guest network default egress policy is allow; false if default egress policy is deny", - "name": "egressdefaultpolicy", - "type": "boolean" - }, - { - "description": "true if network offering supports public access for guest networks", - "name": "supportspublicaccess", + "description": "true if network offering can be used by VPC networks only", + "name": "forvpc", "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 list of supported services", "name": "service", "response": [ + { + "description": "the service name", + "name": "name", + "type": "string" + }, { "description": "the list of capabilities", "name": "capability", "response": [ { - "description": "can this service capability value can be choosable while creatine network offerings", - "name": "canchooseservicecapability", - "type": "boolean" + "description": "the capability name", + "name": "name", + "type": "string" }, { "description": "the capability value", @@ -75560,9 +77150,9 @@ "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" @@ -75572,23 +77162,8 @@ "name": "provider", "response": [ { - "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": "uuid of the network provider", - "name": "id", + "description": "the physical network this belongs to", + "name": "physicalnetworkid", "type": "string" }, { @@ -75596,45 +77171,65 @@ "name": "canenableindividualservice", "type": "boolean" }, + { + "description": "the provider name", + "name": "name", + "type": "string" + }, { "description": "the destination physical network", "name": "destinationphysicalnetworkid", "type": "string" }, + { + "description": "uuid of the network provider", + "name": "id", + "type": "string" + }, { "description": "state of the network provider", "name": "state", "type": "string" + }, + { + "description": "services for this provider", + "name": "servicelist", + "type": "list" } ], "type": "list" - }, - { - "description": "the service name", - "name": "name", - "type": "string" } ], "type": "list" }, { - "description": "the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "domainid", + "description": "the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "zone", "type": "string" }, { - "description": "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": "state of the network offering. Can be Disabled/Enabled/Inactive", - "name": "state", + "description": "the id of the network offering", + "name": "id", "type": "string" }, { - "description": "the tags for the network offering", - "name": "tags", + "description": "true if network offering supports specifying ip ranges, false otherwise", + "name": "specifyipranges", + "type": "boolean" + }, + { + "description": "true if network offering supports vlans, false otherwise", + "name": "specifyvlan", + "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" }, { @@ -75643,26 +77238,95 @@ "type": "string" }, { - "description": "maximum number of concurrents connections to be handled by lb", - "name": "maxconnections", + "description": "state of the network offering. Can be Disabled/Enabled/Inactive", + "name": "state", + "type": "string" + }, + { + "description": "the traffic type for the network offering, supported types are Public, Management, Control, Guest, Vlan or Storage.", + "name": "traffictype", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "additional key/value details tied with network offering", + "name": "details", + "type": "map" + }, + { + "description": "the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "domainid", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, + { + "description": "guest type of the network offering, can be Shared or Isolated", + "name": "guestiptype", + "type": "string" + }, + { + "description": "availability of the network offering", + "name": "availability", + "type": "string" + }, + { + "description": "the ID of the service offering used by virtual router provider", + "name": "serviceofferingid", + "type": "string" + }, + { + "description": "the date this network offering was created", + "name": "created", + "type": "date" + }, { "description": "true if network offering is ip conserve mode enabled", "name": "conservemode", "type": "boolean" }, { - "description": "true if network offering supports network that span multiple zones", - "name": "supportsstrechedl2subnet", + "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": "availability of the network offering", - "name": "availability", + "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": "an alternate display text of the network offering.", + "name": "displaytext", + "type": "string" + }, + { + "description": "true if network offering supports network that span multiple zones", + "name": "supportsstrechedl2subnet", + "type": "boolean" + }, + { + "description": "true if guest network default egress policy is allow; false if default egress policy is deny", + "name": "egressdefaultpolicy", + "type": "boolean" + } ] }, { @@ -75670,25 +77334,17 @@ "isasync": false, "name": "listDedicatedPods", "params": [ - { - "description": "the ID of the pod", - "length": 255, - "name": "podid", - "related": "updatePod,createManagementNetworkIpRange", - "required": false, - "type": "uuid" - }, { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, { - "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" }, @@ -75700,6 +77356,13 @@ "required": false, "type": "uuid" }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + }, { "description": "list dedicated pods by affinity group", "length": 255, @@ -75709,32 +77372,26 @@ "type": "uuid" }, { - "description": "the name of the account associated with the pod. Must be used with domainId.", + "description": "the ID of the pod", "length": 255, - "name": "account", + "name": "podid", + "related": "updatePod,createManagementNetworkIpRange", "required": false, - "type": "string" + "type": "uuid" }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" } ], "related": "", "response": [ - {}, - {}, - { - "description": "the ID of the dedicated resource", - "name": "id", - "type": "string" - }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the Dedication Affinity Group ID of the pod", + "name": "affinitygroupid", "type": "string" }, { @@ -75748,23 +77405,30 @@ "type": "string" }, { - "description": "the Dedication Affinity Group ID of the pod", - "name": "affinitygroupid", + "description": "the Name of the Pod", + "name": "podname", "type": "string" }, { - "description": "the domain ID to which the Pod is dedicated", - "name": "domainid", + "description": "the ID of the dedicated resource", + "name": "id", "type": "string" }, + {}, { "description": "the ID of the Pod", "name": "podid", "type": "string" }, { - "description": "the Name of the Pod", - "name": "podname", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + {}, + { + "description": "the domain ID to which the Pod is dedicated", + "name": "domainid", "type": "string" } ] @@ -75774,14 +77438,6 @@ "isasync": true, "name": "migrateVirtualMachineWithVolume", "params": [ - { - "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": "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, @@ -75793,143 +77449,481 @@ "description": "Destination Host ID to migrate VM to.", "length": 255, "name": "hostid", - "related": "addHost,cancelHostAsDegraded,declareHostAsDegraded,reconnectHost,addBaremetalHost", + "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" } ], "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": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "the pool type of the virtual machine", + "name": "pooltype", + "type": "string" + }, + { + "description": "ssh key-pairs", + "name": "keypairs", + "type": "string" + }, + { + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" + }, + { + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" + }, + { + "description": "Os type ID of the virtual machine", + "name": "guestosid", + "type": "string" + }, + { + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" + }, + { + "description": "Guest vm Boot Mode", + "name": "bootmode", + "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", + "type": "string" + }, + { + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" + }, + { + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" + }, + { + "description": "Guest vm Boot Type", + "name": "boottype", + "type": "string" + }, + { + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" + }, + { + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", + "type": "string" + }, + { + "description": "the account associated with the virtual machine", + "name": "account", + "type": "string" + }, + {}, + { + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", + "type": "string" + }, + { + "description": "the group ID of the virtual machine", + "name": "groupid", + "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": "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": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + } + ], + "type": "set" + }, + { + "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 password (if exists) of the virtual machine", + "name": "password", + "type": "string" + }, + { + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", + "type": "string" + }, + { + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" + }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" + }, + { + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", "type": "boolean" }, { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", + "description": "the name of the virtual machine", + "name": "name", + "type": "string" + }, + { + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" + }, + { + "description": "the list of nics associated with vm", + "name": "nic", + "response": [ + { + "description": "the ID of the corresponding network", + "name": "networkid", + "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 broadcast uri of the nic", + "name": "broadcasturi", + "type": "string" + }, + { + "description": "the traffic type of the nic", + "name": "traffictype", + "type": "string" + }, + { + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "true if nic is default, false otherwise", + "name": "macaddress", + "type": "string" + }, + { + "description": "the 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 IPv6 address of network", + "name": "ip6address", + "type": "string" + }, + { + "description": "the type of the nic", + "name": "type", + "type": "string" + }, + { + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", + "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": "the name of the corresponding network", + "name": "networkname", + "type": "string" + }, + { + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" + }, + { + "description": "the ip address of the nic", + "name": "ipaddress", + "type": "string" + }, + { + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" + }, + { + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", + "type": "string" + }, + { + "description": "the ID of the nic", + "name": "id", + "type": "string" + }, + { + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", + "type": "string" + }, + { + "description": "the isolation uri of the nic", + "name": "isolationuri", + "type": "string" + }, + { + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" + }, + { + "description": "the netmask of the nic", + "name": "netmask", + "type": "string" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + }, + { + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "State of the Service from LB rule", + "name": "servicestate", "type": "string" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "the number of cpu this virtual machine is running with", - "name": "cpunumber", - "type": "integer" - }, - { - "description": "the internal memory that's free in vm or zero if it can not be calculated", - "name": "memoryintfreekbs", - "type": "long" - }, - { - "description": "the speed of each cpu", - "name": "cpuspeed", - "type": "integer" + "description": "OS type id of the vm", + "name": "ostypeid", + "type": "string" }, { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", "type": "boolean" }, - { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", - "type": "string" - }, { "description": "the project name of the vm", "name": "project", "type": "string" }, { - "description": "the read (io) of disk on the vm", - "name": "diskioread", - "type": "long" + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" }, { - "description": "the group ID of the virtual machine", - "name": "groupid", + "description": "the ID of the host for the virtual machine", + "name": "hostid", "type": "string" }, { - "description": "the user's name who deployed the virtual machine", - "name": "username", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "the password (if exists) of the virtual machine", - "name": "password", + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", "type": "string" }, { - "description": "OS type id of the vm", - "name": "ostypeid", + "description": "the group name of the virtual machine", + "name": "group", "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", + "description": "the name of the disk offering of the virtual machine", + "name": "diskofferingname", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the ID of the availablility zone for the virtual machine", + "name": "zoneid", "type": "string" }, { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", + "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", - "name": "diskofferingid", - "type": "string" + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" }, { - "description": "the write (io) of disk on the vm", - "name": "diskiowrite", + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", "type": "long" }, { - "description": "the name of the disk offering of the virtual machine", - "name": "diskofferingname", - "type": "string" + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" }, { - "description": "the ID of the availablility zone for the virtual machine", - "name": "zoneid", - "type": "string" + "description": "the 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 ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { - "description": "the ID of the virtual machine", - "name": "id", + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", "type": "string" }, { - "description": "the vgpu type used by the virtual machine", - "name": "vgpu", + "description": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" + }, + { + "description": "the memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", + "description": "the state of the virtual machine", + "name": "state", "type": "string" }, { - "description": "the memory used by the vm", - "name": "memorykbs", - "type": "long" + "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", @@ -75937,161 +77931,58 @@ "type": "integer" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", - "type": "string" + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", + "type": "boolean" }, { - "description": "the write (bytes) of disk on the vm", - "name": "diskkbswrite", - "type": "long" + "description": "device type of the root volume", + "name": "rootdevicetype", + "type": "string" }, { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", - "type": "string" + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" }, { - "description": "the name of the host for the virtual machine", - "name": "hostname", + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", "type": "string" }, + {}, { - "description": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", - "response": [ - { - "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": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" - }, - { - "description": "the type of the affinity group", - "name": "type", - "type": "string" - }, - { - "description": "the ID of the affinity group", - "name": "id", - "type": "string" - }, - { - "description": "the project ID of the affinity group", - "name": "projectid", - "type": "string" - }, - { - "description": "the domain ID of the affinity group", - "name": "domainid", - "type": "string" - }, - { - "description": "the project name of the affinity group", - "name": "project", - "type": "string" - }, - { - "description": "the name of the affinity group", - "name": "name", - "type": "string" - } - ], - "type": "set" + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", + "type": "string" }, { - "description": "the list of resource tags associated", - "name": "tags", - "response": [ - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "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 key name", - "name": "key", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - } - ], - "type": "set" + "description": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" }, { "description": "list of security groups associated with the virtual machine", "name": "securitygroup", "response": [ { - "description": "the description of the security group", - "name": "description", - "type": "string" - }, - { - "description": "the list of ingress rules associated with the security group", - "name": "ingressrule", + "description": "the list of egress rules associated with the security group", + "name": "egressrule", "response": [ { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" + "description": "the 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 type of the ICMP message response", @@ -76103,28 +77994,23 @@ "name": "tags", "response": [ { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "tag key name", + "name": "key", "type": "string" }, { @@ -76133,13 +78019,13 @@ "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { @@ -76151,97 +78037,87 @@ "description": "the project id the tag belongs to", "name": "projectid", "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" } ], "type": "set" }, { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" + "description": "the 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 protocol of the security group rule", - "name": "protocol", + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", "type": "string" }, - { - "description": "the 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 ending IP of the security group rule ", + "name": "endport", + "type": "integer" } ], "type": "set" }, { - "description": "the project name of the group", - "name": "project", - "type": "string" + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" }, { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" + "description": "the ID of the security group", + "name": "id", + "type": "string" }, { - "description": "the domain ID of the security group", - "name": "domainid", + "description": "the domain name of the security group", + "name": "domain", "type": "string" }, { - "description": "the list of egress rules associated with the security group", - "name": "egressrule", + "description": "the list of ingress rules associated with the security group", + "name": "ingressrule", "response": [ { - "description": "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 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": "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", + "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", @@ -76252,13 +78128,18 @@ "name": "tags", "response": [ { - "description": "tag value", - "name": "value", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { @@ -76267,13 +78148,13 @@ "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 key name", - "name": "key", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { @@ -76282,68 +78163,68 @@ "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "tag value", + "name": "value", "type": "string" }, { "description": "the domain associated with the tag", "name": "domain", "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" } ], "type": "set" }, { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" } ], "type": "set" }, + { + "description": "the project id of the group", + "name": "projectid", + "type": "string" + }, { "description": "the account owning the security group", "name": "account", "type": "string" }, + { + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" + }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "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", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "tag key name", + "name": "key", "type": "string" }, { @@ -76357,8 +78238,13 @@ "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", "type": "string" }, { @@ -76366,369 +78252,348 @@ "name": "project", "type": "string" }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, { "description": "tag value", "name": "value", "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" } ], "type": "set" }, { - "description": "the name of the security group", - "name": "name", + "description": "the domain ID of the security group", + "name": "domainid", "type": "string" }, { - "description": "the project id of the group", - "name": "projectid", + "description": "the name of the security group", + "name": "name", "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 description of the security group", + "name": "description", "type": "string" }, { - "description": "the domain name of the security group", - "name": "domain", + "description": "the project name of the group", + "name": "project", "type": "string" } ], "type": "set" }, { - "description": "the read (bytes) of disk on the vm", - "name": "diskkbsread", - "type": "long" + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", + "type": "string" }, - {}, { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" + "description": "the ID of the virtual machine", + "name": "id", + "type": "string" }, { - "description": "the group name of the virtual machine", - "name": "group", + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", "type": "string" }, { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", + "description": "the read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" + }, + { + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", "type": "string" }, { - "description": "the pool type of the virtual machine", - "name": "pooltype", + "description": "the project id of the vm", + "name": "projectid", "type": "string" }, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "the outgoing network traffic on the host", - "name": "networkkbswrite", - "type": "long" + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", + "type": "string" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "the user's name who deployed the virtual machine", + "name": "username", "type": "string" }, { - "description": "the state of the virtual machine", - "name": "state", + "description": "OS name of the vm", + "name": "osdisplayname", "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", "type": "string" }, { - "description": "the incoming network traffic on the vm", + "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 name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { - "description": "device type of the root volume", - "name": "rootdevicetype", + "description": "the ID of the disk offering of the virtual machine", + "name": "diskofferingid", "type": "string" }, { - "description": "the list of nics associated with vm", - "name": "nic", + "description": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", "response": [ { - "description": "the IPv6 address of network", - "name": "ip6address", - "type": "string" - }, - { - "description": "the ID of the corresponding network", - "name": "networkid", - "type": "string" - }, - { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", - "type": "string" - }, - { - "description": "the isolation uri of the nic", - "name": "isolationuri", - "type": "string" - }, - { - "description": "the netmask of the nic", - "name": "netmask", - "type": "string" - }, - { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - }, - { - "description": "the type of the nic", + "description": "the type of the affinity group", "name": "type", "type": "string" }, { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" - }, - { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", - "type": "string" - }, - { - "description": "the gateway of the nic", - "name": "gateway", - "type": "string" - }, - { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "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 name of the corresponding network", - "name": "networkname", + "description": "the ID of the affinity group", + "name": "id", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "description": "the ip address of the nic", - "name": "ipaddress", + "description": "the project name of the affinity group", + "name": "project", "type": "string" }, { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "the domain ID of the affinity group", + "name": "domainid", "type": "string" }, { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", + "description": "the project ID of the affinity group", + "name": "projectid", "type": "string" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", - "type": "string" + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" }, { - "description": "the ID of the nic", - "name": "id", + "description": "the name of the affinity group", + "name": "name", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "the domain name of the affinity group", + "name": "domain", "type": "string" }, { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" - }, - { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the description of the affinity group", + "name": "description", "type": "string" }, { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "the account owning the affinity group", + "name": "account", "type": "string" } ], "type": "set" - }, + } + ] + }, + { + "description": "Lists VPCs", + "isasync": false, + "name": "listVPCs", + "params": [ { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "List by display text of the VPC", + "length": 255, + "name": "displaytext", + "required": false, "type": "string" }, { - "description": "the target memory in vm", - "name": "memorytargetkbs", - "type": "long" - }, - { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", - "type": "boolean" + "description": "list VPC by id", + "length": 255, + "name": "id", + "related": "listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", + "required": false, + "type": "uuid" }, { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", + "description": "list VPCs by state", + "length": 255, + "name": "state", + "required": false, "type": "string" }, { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "length": 255, + "name": "listall", + "required": false, + "type": "boolean" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", - "type": "string" + "description": "List resources by tags (key/value pairs)", + "length": 255, + "name": "tags", + "required": false, + "type": "map" }, { - "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 total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" + "description": "flag to display the resource icon for VPCs", + "length": 255, + "name": "showicon", + "required": false, + "type": "boolean" }, { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", - "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 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": "ssh key-pair", - "name": "keypair", - "type": "string" + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", - "type": "string" + "description": "list VPCs by restartRequired option", + "length": 255, + "name": "restartrequired", + "required": false, + "type": "boolean" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", - "type": "string" + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", - "type": "string" + "description": "list VPC supporting certain services", + "length": 255, + "name": "supportedservices", + "required": false, + "type": "list" }, { - "description": "Guest vm Boot Type", - "name": "boottype", - "type": "string" + "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "length": 255, + "name": "fordisplay", + "required": false, + "since": "4.4", + "type": "boolean" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" }, - {}, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "list resources by account. Must be used with the domainId parameter.", + "length": 255, + "name": "account", + "required": false, "type": "string" }, { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" + "description": "list by name of the VPC", + "length": 255, + "name": "name", + "required": false, + "type": "string" }, { - "description": "State of the Service from LB rule", - "name": "servicestate", - "type": "string" + "description": "list by zone", + "length": 255, + "name": "zoneid", + "related": "createZone,listZones,listZones", + "required": false, + "type": "uuid" }, { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" + "description": "list by ID of the VPC offering", + "length": 255, + "name": "vpcofferingid", + "related": "updateVPCOffering", + "required": false, + "type": "uuid" }, { - "description": "the name of the virtual machine", - "name": "name", + "description": "list by cidr of the VPC. All VPC guest networks' cidrs should be within this CIDR", + "length": 255, + "name": "cidr", + "required": false, "type": "string" - }, + } + ], + "related": "createVPC,listVPCs,updateVPC,migrateVPC", + "response": [ { - "description": "the project id of the vm", - "name": "projectid", + "description": "the domain id of the VPC owner", + "name": "domainid", "type": "string" }, { - "description": "the name of the availability zone for the virtual machine", + "description": "the name of the zone the VPC belongs to", "name": "zonename", "type": "string" }, { - "description": "OS name of the vm", - "name": "osdisplayname", + "description": "the cidr the VPC", + "name": "cidr", "type": "string" }, { @@ -76737,212 +78602,183 @@ "type": "resourceiconresponse" }, { - "description": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" - }, - { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" - }, - { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", - "type": "boolean" - } - ] - }, - { - "description": "Lists VPCs", - "isasync": false, - "name": "listVPCs", - "params": [ - { - "description": "list VPCs by restartRequired option", - "length": 255, - "name": "restartrequired", - "required": false, - "type": "boolean" - }, - { - "description": "list VPCs by state", - "length": 255, + "description": "state of the VPC. Can be Inactive/Enabled", "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", - "length": 255, - "name": "listall", - "required": false, - "type": "boolean" - }, - { - "description": "list by cidr of the VPC. All VPC guest networks' cidrs should be within this CIDR", - "length": 255, - "name": "cidr", - "required": false, + "description": "an alternate display text of the VPC.", + "name": "displaytext", "type": "string" }, { - "description": "list by zone", - "length": 255, - "name": "zoneid", - "related": "createZone,listZones,listZones", - "required": false, - "type": "uuid" + "description": "vpc offering name the VPC is created from", + "name": "vpcofferingname", + "type": "string" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" + "description": "the owner of the VPC", + "name": "account", + "type": "string" }, + {}, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" + "description": "is VPC uses distributed router for one hop forwarding and host based network ACL's", + "name": "distributedvpcrouter", + "type": "boolean" }, { - "description": "list objects by project", - "length": 255, - "name": "projectid", - "related": "activateProject,suspendProject,updateProject", - "required": false, - "type": "uuid" + "description": "zone id of the vpc", + "name": "zoneid", + "type": "string" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", - "length": 255, - "name": "isrecursive", - "required": false, - "type": "boolean" + "description": "the network domain of the VPC", + "name": "networkdomain", + "type": "string" }, { - "description": "flag to display the resource icon for VPCs", - "length": 255, - "name": "showicon", - "required": false, + "description": "if this VPC has redundant router", + "name": "redundantvpcrouter", "type": "boolean" }, { - "description": "list VPC supporting certain services", - "length": 255, - "name": "supportedservices", - "required": false, + "description": "the list of networks belongign to the VPC", + "name": "network", "type": "list" }, { - "description": "List by display text of the VPC", - "length": 255, - "name": "displaytext", - "required": false, - "type": "string" - }, - { - "description": "List resources by tags (key/value pairs)", - "length": 255, - "name": "tags", - "required": false, - "type": "map" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "list by name of the VPC", - "length": 255, - "name": "name", - "required": false, + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "list by ID of the VPC offering", - "length": 255, - "name": "vpcofferingid", - "related": "updateVPCOffering", - "required": false, - "type": "uuid" + "description": "the id of the VPC", + "name": "id", + "type": "string" }, { - "description": "list VPC by id", - "length": 255, - "name": "id", - "related": "listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", - "required": false, - "type": "uuid" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "list resources by account. Must be used with the domainId parameter.", - "length": 255, - "name": "account", - "required": false, + "description": "the name of the VPC", + "name": "name", "type": "string" }, { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", - "length": 255, + "description": "the project name of the VPC", + "name": "project", + "type": "string" + }, + { + "description": "is vpc for display to the regular user", "name": "fordisplay", - "required": false, - "since": "4.4", "type": "boolean" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "the project id of the VPC", + "name": "projectid", "type": "string" }, { - "description": "list only resources belonging to the domain specified", - "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", - "required": false, - "type": "uuid" - } - ], - "related": "createVPC,listVPCs,updateVPC,migrateVPC", - "response": [ + "description": "true if VPC is region level", + "name": "regionlevelvpc", + "type": "boolean" + }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "vpc offering id the VPC is created from", + "name": "vpcofferingid", "type": "string" }, + {}, { "description": "the date this VPC was created", "name": "created", "type": "date" }, { - "description": "the list of networks belongign to the VPC", - "name": "network", + "description": "the domain name of the owner", + "name": "domain", + "type": "string" + }, + { + "description": "the list of resource tags associated with the project", + "name": "tags", + "response": [ + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + } + ], "type": "list" }, { - "description": "vpc offering name the VPC is created from", - "name": "vpcofferingname", - "type": "string" + "description": "The routes for the network to ease adding route in upstream router", + "name": "ip6routes", + "type": "set" }, - {}, { - "description": "the project id of the VPC", - "name": "projectid", - "type": "string" + "description": "true VPC requires restart", + "name": "restartrequired", + "type": "boolean" }, - {}, { "description": "the list of supported services", "name": "service", "response": [ - { - "description": "the service name", - "name": "name", - "type": "string" - }, { "description": "the service provider name", "name": "provider", @@ -76952,21 +78788,11 @@ "name": "name", "type": "string" }, - { - "description": "uuid of the network provider", - "name": "id", - "type": "string" - }, { "description": "services for this provider", "name": "servicelist", "type": "list" }, - { - "description": "true if individual services can be enabled/disabled", - "name": "canenableindividualservice", - "type": "boolean" - }, { "description": "the physical network this belongs to", "name": "physicalnetworkid", @@ -76981,14 +78807,34 @@ "description": "the destination physical network", "name": "destinationphysicalnetworkid", "type": "string" + }, + { + "description": "uuid of the network provider", + "name": "id", + "type": "string" + }, + { + "description": "true if individual services can be enabled/disabled", + "name": "canenableindividualservice", + "type": "boolean" } ], "type": "list" }, + { + "description": "the service name", + "name": "name", + "type": "string" + }, { "description": "the list of capabilities", "name": "capability", "response": [ + { + "description": "can this service capability value can be choosable while creatine network offerings", + "name": "canchooseservicecapability", + "type": "boolean" + }, { "description": "the capability name", "name": "name", @@ -76998,177 +78844,51 @@ "description": "the capability value", "name": "value", "type": "string" - }, - { - "description": "can this service capability value can be choosable while creatine network offerings", - "name": "canchooseservicecapability", - "type": "boolean" } ], "type": "list" } ], "type": "list" - }, - { - "description": "the domain name of the owner", - "name": "domain", - "type": "string" - }, - { - "description": "if this VPC has redundant router", - "name": "redundantvpcrouter", - "type": "boolean" - }, - { - "description": "the list of resource tags associated with the project", - "name": "tags", - "response": [ - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - } - ], - "type": "list" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "zone id of the vpc", - "name": "zoneid", - "type": "string" - }, - { - "description": "is VPC uses distributed router for one hop forwarding and host based network ACL's", - "name": "distributedvpcrouter", - "type": "boolean" - }, - { - "description": "the name of the VPC", - "name": "name", - "type": "string" - }, - { - "description": "the domain id of the VPC owner", - "name": "domainid", - "type": "string" - }, - { - "description": "the name of the zone the VPC belongs to", - "name": "zonename", - "type": "string" - }, - { - "description": "the network domain of the VPC", - "name": "networkdomain", - "type": "string" - }, - { - "description": "true VPC requires restart", - "name": "restartrequired", - "type": "boolean" - }, - { - "description": "vpc offering id the VPC is created from", - "name": "vpcofferingid", - "type": "string" - }, - { - "description": "state of the VPC. Can be Inactive/Enabled", - "name": "state", - "type": "string" - }, - { - "description": "the cidr the VPC", - "name": "cidr", - "type": "string" - }, - { - "description": "an alternate display text of the VPC.", - "name": "displaytext", - "type": "string" - }, + } + ] + }, + { + "description": "Adds a network device of one of the following types: ExternalDhcp, ExternalFirewall, ExternalLoadBalancer, PxeServer", + "isasync": false, + "name": "addNetworkDevice", + "params": [ { - "description": "the owner of the VPC", - "name": "account", + "description": "Network device type, now supports ExternalDhcp, PxeServer, NetscalerMPXLoadBalancer, NetscalerVPXLoadBalancer, NetscalerSDXLoadBalancer, F5BigIpLoadBalancer, JuniperSRXFirewall, PaloAltoFirewall", + "length": 255, + "name": "networkdevicetype", + "required": false, "type": "string" }, { - "description": "is vpc for display to the regular user", - "name": "fordisplay", - "type": "boolean" - }, + "description": "parameters for network device", + "length": 255, + "name": "networkdeviceparameterlist", + "required": false, + "type": "map" + } + ], + "related": "", + "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": "true if VPC is region level", - "name": "regionlevelvpc", - "type": "boolean" - }, - { - "description": "the project name of the VPC", - "name": "project", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the id of the VPC", + "description": "the ID of the network device", "name": "id", "type": "string" } @@ -77180,11 +78900,12 @@ "name": "runDiagnostics", "params": [ { - "description": "Additional command line options that apply for each command", + "description": "The ID of the system VM instance to diagnose", "length": 255, - "name": "params", - "required": false, - "type": "string" + "name": "targetid", + "related": "migrateSystemVm,startSystemVm", + "required": true, + "type": "uuid" }, { "description": "The IP/Domain address to test connection to", @@ -77194,93 +78915,51 @@ "type": "string" }, { - "description": "The system VM diagnostics type valid options are: ping, traceroute, arping", + "description": "Additional command line options that apply for each command", "length": 255, - "name": "type", - "required": true, + "name": "params", + "required": false, "type": "string" }, { - "description": "The ID of the system VM instance to diagnose", + "description": "The system VM diagnostics type valid options are: ping, traceroute, arping", "length": 255, - "name": "targetid", - "related": "migrateSystemVm,startSystemVm", + "name": "type", "required": true, - "type": "uuid" + "type": "string" } ], "related": "", "response": [ - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, { "description": "the standard error output from the command execution", "name": "stderr", "type": "string" }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "the command execution return code", "name": "exitcode", "type": "string" }, {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "the standard output from the command execution", "name": "stdout", "type": "string" }, - {} - ], - "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": "parameters for network device", - "length": 255, - "name": "networkdeviceparameterlist", - "required": false, - "type": "map" - }, - { - "description": "Network device type, now supports ExternalDhcp, PxeServer, NetscalerMPXLoadBalancer, NetscalerVPXLoadBalancer, NetscalerSDXLoadBalancer, F5BigIpLoadBalancer, JuniperSRXFirewall, PaloAltoFirewall", - "length": 255, - "name": "networkdevicetype", - "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": "the ID of the network device", - "name": "id", - "type": "string" } - ] + ], + "since": "4.12.0.0" }, { "description": "Updates a user account", @@ -77288,37 +78967,37 @@ "name": "updateUser", "params": [ { - "description": "last name", + "description": "The secret key for the user. Must be specified with userApiKey", "length": 255, - "name": "lastname", + "name": "usersecretkey", "required": false, "type": "string" }, { - "description": "The secret key for the user. Must be specified with userApiKey", + "description": "Unique username", "length": 255, - "name": "usersecretkey", + "name": "username", "required": false, "type": "string" }, { - "description": "Specifies a timezone for this command. For more information on the timezone parameter, see Time Zone Format.", + "description": "first name", "length": 255, - "name": "timezone", + "name": "firstname", "required": false, "type": "string" }, { - "description": "The API key for the user. Must be specified with userSecretKey", + "description": "email", "length": 255, - "name": "userapikey", + "name": "email", "required": false, "type": "string" }, { - "description": "Unique username", + "description": "Current password that was being used by the user. You must inform the current password when updating the password.", "length": 255, - "name": "username", + "name": "currentpassword", "required": false, "type": "string" }, @@ -77331,30 +79010,30 @@ "type": "uuid" }, { - "description": "first name", + "description": "The API key for the user. Must be specified with userSecretKey", "length": 255, - "name": "firstname", + "name": "userapikey", "required": false, "type": "string" }, { - "description": "email", + "description": "last name", "length": 255, - "name": "email", + "name": "lastname", "required": false, "type": "string" }, { - "description": "Clear text password (default hashed to SHA256SALT). If you wish to use any other hashing algorithm, you would need to write a custom authentication adapter. Can't be passed when command is executed via integration.api.port", + "description": "Specifies a timezone for this command. For more information on the timezone parameter, see Time Zone Format.", "length": 255, - "name": "password", + "name": "timezone", "required": false, "type": "string" }, { - "description": "Current password that was being used by the user. You must inform the current password when updating the password.", + "description": "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": "currentpassword", + "name": "password", "required": false, "type": "string" } @@ -77362,23 +79041,24 @@ "related": "createUser,disableUser,enableUser,getUser,listUsers", "response": [ { - "description": "the type of the role", - "name": "roletype", + "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 account type of the user", + "name": "accounttype", + "type": "integer" }, + {}, { - "description": "the date and time the user account was created", - "name": "created", - "type": "date" + "description": "the user lastname", + "name": "lastname", + "type": "string" }, { - "description": "the user name", - "name": "username", + "description": "the timezone user was created in", + "name": "timezone", "type": "string" }, { @@ -77386,71 +79066,85 @@ "name": "id", "type": "string" }, + { + "description": "the boolean value representing if the updating target is in caller's child domain", + "name": "iscallerchilddomain", + "type": "boolean" + }, + { + "description": "the user state", + "name": "state", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + {}, + { + "description": "the domain name of the user", + "name": "domain", + "type": "string" + }, + { + "description": "the account ID of the user", + "name": "accountid", + "type": "string" + }, { "description": "the name of the role", "name": "rolename", "type": "string" }, { - "description": "the timezone user was created in", - "name": "timezone", + "description": "the api key of the user", + "name": "apikey", "type": "string" }, { - "description": "the account ID of the user", - "name": "accountid", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the secret key of the user", - "name": "secretkey", + "description": "the type of the role", + "name": "roletype", "type": "string" }, { - "description": "the boolean value representing if the updating target is in caller's child domain", - "name": "iscallerchilddomain", - "type": "boolean" - }, - { - "description": "the user state", - "name": "state", + "description": "the domain ID of the user", + "name": "domainid", "type": "string" }, { - "description": "the ID of the role", - "name": "roleid", + "description": "the secret key of the user", + "name": "secretkey", "type": "string" }, { - "description": "true if user is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "the 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", "type": "string" }, { - "description": "the user lastname", - "name": "lastname", + "description": "the user name", + "name": "username", "type": "string" }, - {}, - { - "description": "the account type of the user", - "name": "accounttype", - "type": "short" - }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the user email address", + "name": "email", "type": "string" }, { - "description": "the api key of the user", - "name": "apikey", + "description": "the ID of the role", + "name": "roleid", "type": "string" }, { @@ -77458,30 +79152,15 @@ "name": "firstname", "type": "string" }, - { - "description": "the account name of the user", - "name": "account", - "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 domain name of the user", - "name": "domain", - "type": "string" - }, - { - "description": "the domain ID of the user", - "name": "domainid", - "type": "string" + "description": "true if user is default, false otherwise", + "name": "isdefault", + "type": "boolean" } ] }, @@ -77490,13 +79169,6 @@ "isasync": true, "name": "restartVPC", "params": [ - { - "description": "Turn a single VPC into a redundant one.", - "length": 255, - "name": "makeredundant", - "required": false, - "type": "boolean" - }, { "description": "the id of the VPC", "length": 255, @@ -77505,6 +79177,21 @@ "required": true, "type": "uuid" }, + { + "description": "Live patches the router software before restarting it. This parameter will only work when 'cleanup' is false.", + "length": 255, + "name": "livepatch", + "required": false, + "since": "4.17.0", + "type": "boolean" + }, + { + "description": "Turn a single VPC into a redundant one.", + "length": 255, + "name": "makeredundant", + "required": false, + "type": "boolean" + }, { "description": "If cleanup old network elements", "length": 255, @@ -77514,6 +79201,12 @@ } ], "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", @@ -77529,13 +79222,7 @@ "description": "true if operation is executed successfully", "name": "success", "type": "boolean" - }, - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - }, - {} + } ] }, { @@ -77547,7 +79234,7 @@ "description": "the ID of the load balancer rule", "length": 255, "name": "lbruleid", - "related": "", + "related": "updateIpv6FirewallRule", "required": true, "type": "uuid" } @@ -77559,7 +79246,6 @@ "name": "jobstatus", "type": "integer" }, - {}, { "description": "true if operation is executed successfully", "name": "success", @@ -77570,6 +79256,7 @@ "name": "displaytext", "type": "string" }, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", @@ -77583,100 +79270,95 @@ "name": "addHost", "params": [ { - "description": "the Pod ID for the host", + "description": "the cluster ID for the host", "length": 255, - "name": "podid", - "related": "updatePod,createManagementNetworkIpRange", - "required": true, + "name": "clusterid", + "related": "addCluster", + "required": false, "type": "uuid" }, { - "description": "hypervisor type of the host", + "description": "the host URL", "length": 255, - "name": "hypervisor", + "name": "url", "required": true, "type": "string" }, { - "description": "the Zone ID for the host", + "description": "the password for the host; required to be passed for hypervisors other than VMWare", "length": 255, - "name": "zoneid", - "related": "createZone,listZones,listZones", - "required": true, - "type": "uuid" + "name": "password", + "required": false, + "type": "string" }, { - "description": "the host URL", + "description": "Allocation state of this Host for allocation of new resources", "length": 255, - "name": "url", - "required": true, + "name": "allocationstate", + "required": false, "type": "string" }, { - "description": "the cluster name for the host", + "description": "list of tags to be added to the host", "length": 255, - "name": "clustername", + "name": "hosttags", "required": false, - "type": "string" + "type": "list" }, { - "description": "the cluster ID for the host", + "description": "the Pod ID for the host", "length": 255, - "name": "clusterid", - "related": "addCluster", - "required": false, + "name": "podid", + "related": "updatePod,createManagementNetworkIpRange", + "required": true, "type": "uuid" }, { - "description": "Allocation state of this Host for allocation of new resources", + "description": "the cluster name for the host", "length": 255, - "name": "allocationstate", + "name": "clustername", "required": false, "type": "string" }, { - "description": "the username for the host; required to be passed for hypervisors other than VMWare", + "description": "the Zone ID for the host", "length": 255, - "name": "username", - "required": false, - "type": "string" + "name": "zoneid", + "related": "createZone,listZones,listZones", + "required": true, + "type": "uuid" }, { - "description": "the password for the host; required to be passed for hypervisors other than VMWare", + "description": "hypervisor type of the host", "length": 255, - "name": "password", - "required": false, + "name": "hypervisor", + "required": true, "type": "string" }, { - "description": "list of tags to be added to the host", + "description": "the username for the host; required to be passed for hypervisors other than VMWare", "length": 255, - "name": "hosttags", + "name": "username", "required": false, - "type": "list" + "type": "string" } ], - "related": "cancelHostAsDegraded,declareHostAsDegraded,reconnectHost,addBaremetalHost", + "related": "addBaremetalHost,cancelHostAsDegraded,declareHostAsDegraded,reconnectHost", "response": [ { - "description": "the amount of the host's CPU currently allocated", - "name": "cpuallocated", - "type": "string" - }, - { - "description": "the cluster type of the cluster that host belongs to", - "name": "clustertype", + "description": "the cluster name of the host", + "name": "clustername", "type": "string" }, { - "description": "the OS category ID of the host", - "name": "oscategoryid", - "type": "string" + "description": "Host details in key/value pairs.", + "name": "details", + "type": "map" }, { - "description": "the number of CPU sockets on the host", - "name": "cpusockets", - "type": "integer" + "description": "the cpu average load on the host", + "name": "cpuloadaverage", + "type": "double" }, { "description": "the Pod ID of the host", @@ -77684,59 +79366,88 @@ "type": "string" }, { - "description": "events available for the host", - "name": "events", - "type": "string" - }, - { - "description": "the state of the host", - "name": "state", - "type": "status" - }, - { - "description": "the amount of the host's CPU currently used", - "name": "cpuused", - "type": "string" - }, - { - "description": "the resource state of the host", - "name": "resourcestate", - "type": "string" + "description": "true if this host is suitable(has enough capacity and satisfies all conditions like hosttags, max guests vm limit etc) to migrate a VM to it , false otherwise", + "name": "suitableformigration", + "type": "boolean" }, { - "description": "the cluster ID of the host", - "name": "clusterid", + "description": "the amount of the host's CPU currently allocated in percentage", + "name": "cpuallocatedpercentage", "type": "string" }, { - "description": "the host out-of-band management information", - "name": "outofbandmanagement", - "type": "outofbandmanagementresponse" - }, - { - "description": "the cluster name of the host", - "name": "clustername", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the Pod name of the host", - "name": "podname", - "type": "string" + "description": "the outgoing network traffic on the host", + "name": "networkkbswrite", + "type": "long" }, { - "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", - "name": "cpuallocatedwithoverprovisioning", + "description": "the amount of the host's memory after applying the mem.overprovisioning.factor", + "name": "memorywithoverprovisioning", "type": "string" }, { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", - "type": "long" - }, - { - "description": "the incoming network traffic on the host", - "name": "networkkbsread", - "type": "long" + "description": "GPU cards present in the host", + "name": "gpugroup", + "response": [ + { + "description": "GPU cards present in the host", + "name": "gpugroupname", + "type": "string" + }, + { + "description": "the list of enabled vGPUs", + "name": "vgpu", + "response": [ + { + "description": "Video RAM for this vGPU type", + "name": "videoram", + "type": "long" + }, + { + "description": "Maximum vgpu can be created with this vgpu type on the given gpu group", + "name": "maxcapacity", + "type": "long" + }, + { + "description": "Model Name of vGPU", + "name": "vgputype", + "type": "string" + }, + { + "description": "Maximum Y resolution per display", + "name": "maxresolutiony", + "type": "long" + }, + { + "description": "Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type", + "name": "remainingcapacity", + "type": "long" + }, + { + "description": "Maximum displays per user", + "name": "maxheads", + "type": "long" + }, + { + "description": "Maximum X resolution per display", + "name": "maxresolutionx", + "type": "long" + }, + { + "description": "Maximum no. of vgpu per gpu card (pgpu)", + "name": "maxvgpuperpgpu", + "type": "long" + } + ], + "type": "list" + } + ], + "type": "list" }, { "description": "the ID of the host", @@ -77744,15 +79455,14 @@ "type": "string" }, { - "description": "the outgoing network traffic on the host", - "name": "networkkbswrite", - "type": "long" + "description": "true if the host is disconnected. False otherwise.", + "name": "disconnected", + "type": "date" }, - {}, { - "description": "the name of the host", - "name": "name", - "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 OS category name of the host", @@ -77760,80 +79470,50 @@ "type": "string" }, { - "description": "the amount of the host's memory after applying the mem.overprovisioning.factor", - "name": "memorywithoverprovisioning", - "type": "string" + "description": "true if the host has capability to support UEFI boot", + "name": "ueficapability", + "type": "boolean" }, { - "description": "the IP address of the host", - "name": "ipaddress", + "description": "the management server ID of the host", + "name": "managementserverid", "type": "string" }, { - "description": "the admin that annotated this host", - "name": "username", + "description": "the IP address of the host", + "name": "ipaddress", "type": "string" }, { - "description": "the amount of the host's CPU currently allocated in percentage", - "name": "cpuallocatedpercentage", + "description": "the amount of the host's CPU currently allocated", + "name": "cpuallocated", "type": "string" }, { - "description": "true if the host is disconnected. False otherwise.", - "name": "disconnected", - "type": "date" - }, - {}, - { - "description": "the date and time the host was last pinged", - "name": "lastpinged", - "type": "date" - }, - { - "description": "the host hypervisor", - "name": "hypervisor", - "type": "hypervisortype" - }, - { - "description": "the CPU speed of the host", - "name": "cpuspeed", + "description": "the total disk size of the host", + "name": "disksizetotal", "type": "long" }, { - "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor", - "name": "cpuwithoverprovisioning", - "type": "string" + "description": "the amount of the host's memory currently allocated", + "name": "memoryallocated", + "type": "long" }, { "description": "the last annotation set on this host by an admin", "name": "annotation", "type": "string" }, - { - "description": "the Zone name of the host", - "name": "zonename", - "type": "string" - }, - { - "description": "Host details in key/value pairs.", - "name": "details", - "type": "map" - }, { "description": "the last time this host was annotated", "name": "lastannotated", "type": "date" }, + {}, { - "description": "the total disk size of the host", - "name": "disksizetotal", - "type": "long" - }, - { - "description": "true if the host has capability to support UEFI boot", - "name": "ueficapability", - "type": "boolean" + "description": "events available for the host", + "name": "events", + "type": "string" }, { "description": "the host HA information information", @@ -77841,183 +79521,190 @@ "type": "hostharesponse" }, { - "description": "the amount of the host's memory currently allocated in bytes", - "name": "memoryallocatedbytes", - "type": "long" - }, - { - "description": "the cpu average load on the host", - "name": "cpuloadaverage", - "type": "double" + "description": "the OS category ID of the host", + "name": "oscategoryid", + "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 and time the host was removed", - "name": "removed", + "description": "the date and time the host was last pinged", + "name": "lastpinged", "type": "date" }, { - "description": "true if this host is suitable(has enough capacity and satisfies all conditions like hosttags, max guests vm limit etc) to migrate a VM to it , false otherwise", - "name": "suitableformigration", + "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 local storage is active, false otherwise", - "name": "islocalstorageactive", - "type": "boolean" + "description": "the cluster ID of the host", + "name": "clusterid", + "type": "string" }, { - "description": "comma-separated list of tags for the host", - "name": "hosttags", + "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor", + "name": "cpuwithoverprovisioning", "type": "string" }, { - "description": "the amount of the host's CPU currently allocated in MHz", - "name": "cpuallocatedvalue", + "description": "the resource state of the host", + "name": "resourcestate", + "type": "string" + }, + { + "description": "the amount of the host's memory currently allocated in bytes", + "name": "memoryallocatedbytes", "type": "long" }, { - "description": "the Zone ID of the host", - "name": "zoneid", - "type": "string" + "description": "the state of the host", + "name": "state", + "type": "status" }, { - "description": "the date and time the host was created", - "name": "created", - "type": "date" + "description": "the amount of the host's memory currently used", + "name": "memoryused", + "type": "long" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the host out-of-band management information", + "name": "outofbandmanagement", + "type": "outofbandmanagementresponse" }, { - "description": "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 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": "Video RAM for this vGPU type", - "name": "videoram", - "type": "long" - }, - { - "description": "Maximum Y resolution per display", - "name": "maxresolutiony", - "type": "long" - }, - { - "description": "Maximum displays per user", - "name": "maxheads", - "type": "long" - }, - { - "description": "Model Name of vGPU", - "name": "vgputype", - "type": "string" - } - ], - "type": "list" - } - ], - "type": "list" + "description": "the amount of the host's memory currently allocated in percentage", + "name": "memoryallocatedpercentage", + "type": "string" + }, + { + "description": "the Zone ID of the host", + "name": "zoneid", + "type": "string" }, { - "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", - "name": "memorytotal", - "type": "long" + "description": "comma-separated list of tags for the host", + "name": "hosttags", + "type": "string" }, { - "description": "the amount of the host's memory currently allocated", - "name": "memoryallocated", - "type": "long" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the host version", - "name": "version", - "type": "string" + "description": "the host hypervisor", + "name": "hypervisor", + "type": "hypervisortype" }, { - "description": "the CPU number of the host", - "name": "cpunumber", - "type": "integer" + "description": "the date and time the host was removed", + "name": "removed", + "type": "date" }, { - "description": "the 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 Pod name of the host", + "name": "podname", "type": "string" }, { - "description": "the management server ID of the host", - "name": "managementserverid", + "description": "the host type", + "name": "type", + "type": "type" + }, + { + "description": "the amount of the host's CPU currently used", + "name": "cpuused", "type": "string" }, + { + "description": "the incoming network traffic on the host", + "name": "networkkbsread", + "type": "long" + }, + { + "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", + "name": "memorytotal", + "type": "long" + }, + {}, { "description": "capabilities of the host", "name": "capabilities", "type": "string" }, + { + "description": "the host's currently allocated disk size", + "name": "disksizeallocated", + "type": "long" + }, + { + "description": "the amount of the host's CPU currently allocated in MHz", + "name": "cpuallocatedvalue", + "type": "long" + }, + { + "description": "true if local storage is active, false otherwise", + "name": "islocalstorageactive", + "type": "boolean" + }, { "description": "the hypervisor version", "name": "hypervisorversion", "type": "string" }, { - "description": "the amount of the host's memory currently used", - "name": "memoryused", - "type": "long" + "description": "the name of the host", + "name": "name", + "type": "string" }, { - "description": "the amount of the host's memory currently allocated in percentage", - "name": "memoryallocatedpercentage", + "description": "the admin that annotated this host", + "name": "username", "type": "string" }, { - "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise", - "name": "hahost", - "type": "boolean" + "description": "the host version", + "name": "version", + "type": "string" }, { - "description": "the host type", - "name": "type", - "type": "type" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise", - "name": "hasenoughcapacity", - "type": "boolean" + "description": "the cluster type of the cluster that host belongs to", + "name": "clustertype", + "type": "string" + }, + { + "description": "the Zone name of the host", + "name": "zonename", + "type": "string" + }, + { + "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", + "name": "cpuallocatedwithoverprovisioning", + "type": "string" + }, + { + "description": "the number of CPU sockets on the host", + "name": "cpusockets", + "type": "integer" + }, + { + "description": "the CPU number of the host", + "name": "cpunumber", + "type": "integer" } ] }, @@ -78035,7 +79722,7 @@ "type": "uuid" }, { - "description": "the ID of the device to map the volume to within the guest OS. If no deviceId is passed in, the next available deviceId will be chosen. Possible values for a Linux OS are:* 0 - /dev/xvda* 1 - /dev/xvdb* 2 - /dev/xvdc* 4 - /dev/xvde* 5 - /dev/xvdf* 6 - /dev/xvdg* 7 - /dev/xvdh* 8 - /dev/xvdi* 9 - /dev/xvdj", + "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, @@ -78053,179 +79740,224 @@ "related": "createVolume,migrateVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", "response": [ { - "description": "the path of the volume", - "name": "path", - "type": "string" + "description": "max iops of the disk volume", + "name": "maxiops", + "type": "long" }, { - "description": "the domain associated with the disk volume", - "name": "domain", + "description": "id of the virtual machine", + "name": "virtualmachineid", "type": "string" }, { - "description": "the state of the disk volume", - "name": "state", + "description": "name of the primary storage hosting the disk volume", + "name": "storage", "type": "string" }, { - "description": "name of the availability zone", - "name": "zonename", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "the ID of the domain associated with the disk volume", + "name": "domainid", "type": "string" }, + {}, { - "description": "cluster id of the volume", - "name": "clusterid", + "description": "the chain info of the volume", + "name": "chaininfo", "type": "string" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "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": "min iops of the disk volume", + "name": "miniops", "type": "long" }, { - "description": "pod name of the volume", - "name": "podname", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { - "description": "Hypervisor the volume belongs to", - "name": "hypervisor", - "type": "string" + "description": "the bytes actually consumed on disk", + "name": "virtualsize", + "type": "long" }, { - "description": "the account associated with the disk volume", - "name": "account", + "description": "cluster id of the volume", + "name": "clusterid", "type": "string" }, { - "description": "cluster name where the volume is allocated", - "name": "clustername", + "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 bytes actually consumed on disk", - "name": "virtualsize", + "description": "the date the disk volume was created", + "name": "created", + "type": "date" + }, + { + "description": "the VM's disk read in KiB", + "name": "diskkbsread", "type": "long" }, { - "description": "ID of the disk offering", - "name": "diskofferingid", + "description": "the project name of the vpn", + "name": "project", "type": "string" }, - {}, { - "description": "the date the disk volume was created", - "name": "created", - "type": "date" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "name of the disk volume", - "name": "name", + "description": "id of the primary storage hosting the disk volume; returned to admin user only", + "name": "storageid", "type": "string" }, { - "description": "pod id of the volume", - "name": "podid", + "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 template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", "type": "string" }, { - "description": "the write (io) of disk on the vm", - "name": "diskiowrite", - "type": "long" + "description": "true if the volume is extractable, false otherwise", + "name": "isextractable", + "type": "boolean" }, { - "description": "the write (bytes) of disk on the vm", - "name": "diskkbswrite", + "description": "IO requests write rate of the disk volume per the disk offering", + "name": "diskIopsWriteRate", "type": "long" }, { - "description": "id of the primary storage hosting the disk volume; returned to admin user only", - "name": "storageid", + "description": "type of the disk volume (ROOT or DATADISK)", + "name": "type", "type": "string" }, { - "description": "the project name of the vpn", - "name": "project", + "description": "the display text of the disk offering", + "name": "diskofferingdisplaytext", "type": "string" }, { - "description": "id of the virtual machine", - "name": "virtualmachineid", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "description": "display name of the virtual machine", - "name": "vmdisplayname", + "description": "ID of the disk offering", + "name": "diskofferingid", "type": "string" }, + { + "description": "bytes read rate of the disk volume", + "name": "diskBytesReadRate", + "type": "long" + }, { "description": "state of the virtual machine", "name": "vmstate", "type": "string" }, - {}, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "pod name of the volume", + "name": "podname", "type": "string" }, { - "description": "max iops of the disk volume", - "name": "maxiops", + "description": "volume uuid that is given by virtualisation provider (only for VMware)", + "name": "externaluuid", + "type": "string" + }, + { + "description": "bytes write rate of the disk volume", + "name": "diskBytesWriteRate", "type": "long" }, { - "description": "the chain info of the volume", - "name": "chaininfo", + "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", - "type": "long" + "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 disk utilization", + "name": "utilization", + "type": "string" }, { - "description": "the bytes allocated", - "name": "physicalsize", + "description": "the account associated with the disk volume", + "name": "account", + "type": "string" + }, + { + "description": "IO requests read rate of the disk volume per the disk offering", + "name": "diskIopsReadRate", "type": "long" }, { - "description": "the read (io) of disk on the vm", - "name": "diskioread", + "description": "the project id of the vpn", + "name": "projectid", + "type": "string" + }, + { + "description": "size of the disk volume", + "name": "size", "type": "long" }, + { + "description": "ID of the availability zone", + "name": "zoneid", + "type": "string" + }, + { + "description": "the boolean state of whether the volume is destroyed or not", + "name": "destroyed", + "type": "boolean" + }, { "description": "the list of resource tags associated", "name": "tags", "response": [ { - "description": "the account associated with the tag", - "name": "account", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { @@ -78234,57 +79966,52 @@ "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": "the domain associated with the tag", - "name": "domain", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "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": "id of the resource", + "name": "resourceid", "type": "string" } ], "type": "set" }, { - "description": "the project id of the vpn", - "name": "projectid", + "description": "cluster name where the volume is allocated", + "name": "clustername", "type": "string" }, { - "description": "name of the service offering for root disk", - "name": "serviceofferingname", + "description": "pod id of the volume", + "name": "podid", "type": "string" }, { - "description": "true if the volume is extractable, false otherwise", - "name": "isextractable", - "type": "boolean" - }, - { - "description": "the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached.", - "name": "deviceid", - "type": "long" + "description": "ID of the service offering for root disk", + "name": "serviceofferingid", + "type": "string" }, { "description": "shared or local storage", @@ -78292,34 +80019,24 @@ "type": "string" }, { - "description": "ID of the service offering for root disk", - "name": "serviceofferingid", + "description": "the domain associated with the disk volume", + "name": "domain", "type": "string" }, { - "description": "io requests read rate of the disk volume per the disk offering", - "name": "diskIopsReadRate", - "type": "long" - }, - { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", + "description": "the path of the volume", + "name": "path", "type": "string" }, { - "description": "the ID of the domain associated with the disk volume", - "name": "domainid", + "description": "name of the virtual machine", + "name": "vmname", "type": "string" }, { - "description": "bytes write rate of the disk volume", - "name": "diskBytesWriteRate", - "type": "long" - }, - { - "description": "provisioning type used to create volumes.", - "name": "provisioningtype", - "type": "string" + "description": "the date the volume was attached to a VM instance", + "name": "attached", + "type": "date" }, { "description": "need quiesce vm or not when taking snapshot", @@ -78327,44 +80044,24 @@ "type": "boolean" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "name of the disk volume", + "name": "name", "type": "string" }, { - "description": "min iops of the disk volume", - "name": "miniops", + "description": "the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached.", + "name": "deviceid", "type": "long" }, { - "description": "ID of the availability zone", - "name": "zoneid", - "type": "string" - }, - { - "description": "the disk utilization", - "name": "utilization", - "type": "string" - }, - { - "description": "the display text of the service offering for root disk", - "name": "serviceofferingdisplaytext", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "true if storage snapshot is supported for the volume, false otherwise", - "name": "supportsstoragesnapshot", - "type": "boolean" - }, - { - "description": "the date the volume was attached to a VM instance", - "name": "attached", - "type": "date" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the write (IO) of disk on the vm", + "name": "diskiowrite", + "type": "long" }, { "description": "ID of the snapshot from which this volume was created", @@ -78372,69 +80069,64 @@ "type": "string" }, { - "description": "name of the virtual machine", - "name": "vmname", - "type": "string" - }, - { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "name of the availability zone", + "name": "zonename", "type": "string" }, { - "description": "the status of the volume", - "name": "status", + "description": "provisioning type used to create volumes.", + "name": "provisioningtype", "type": "string" }, { - "description": "the display text of the disk offering", - "name": "diskofferingdisplaytext", + "description": "ID of the disk volume", + "name": "id", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "display name of the virtual machine", + "name": "vmdisplayname", "type": "string" }, { - "description": "the read (bytes) of disk on the vm", - "name": "diskkbsread", - "type": "long" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "true if storage snapshot is supported for the volume, false otherwise", + "name": "supportsstoragesnapshot", "type": "boolean" }, { - "description": "ID of the disk volume", - "name": "id", + "description": "Hypervisor the volume belongs to", + "name": "hypervisor", "type": "string" }, { - "description": "type of the disk volume (ROOT or DATADISK)", - "name": "type", + "description": "name of the service offering for root disk", + "name": "serviceofferingname", "type": "string" }, { - "description": "size of the disk volume", - "name": "size", + "description": "the bytes allocated", + "name": "physicalsize", "type": "long" }, { - "description": "name of the disk offering", - "name": "diskofferingname", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "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": "name of the primary storage hosting the disk volume", - "name": "storage", - "type": "string" + "description": "the read (IO) of disk on the vm", + "name": "diskioread", + "type": "long" + }, + { + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" } ] }, @@ -78444,9 +80136,9 @@ "name": "addBaremetalDhcp", "params": [ { - "description": "URL of the external dhcp appliance.", + "description": "Type of dhcp device", "length": 255, - "name": "url", + "name": "dhcpservertype", "required": true, "type": "string" }, @@ -78473,42 +80165,42 @@ "type": "string" }, { - "description": "Type of dhcp device", + "description": "URL of the external dhcp appliance.", "length": 255, - "name": "dhcpservertype", + "name": "url", "required": true, "type": "string" } ], "related": "listBaremetalDhcp", "response": [ - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, { "description": "url", "name": "url", "type": "string" }, + {}, + {}, { - "description": "name of the provider", - "name": "dhcpservertype", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {}, { "description": "device id of ", "name": "id", "type": "string" }, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + { + "description": "name of the provider", + "name": "provider", + "type": "string" + }, { "description": "the physical network to which this external dhcp device belongs to", "name": "physicalnetworkid", @@ -78516,7 +80208,7 @@ }, { "description": "name of the provider", - "name": "provider", + "name": "dhcpservertype", "type": "string" } ] @@ -78526,13 +80218,6 @@ "isasync": false, "name": "addTrafficMonitor", "params": [ - { - "description": "Traffic going into the listed zones will not be metered", - "length": 255, - "name": "excludezones", - "required": false, - "type": "string" - }, { "description": "Zone in which to add the external firewall appliance.", "length": 255, @@ -78541,39 +80226,52 @@ "required": true, "type": "uuid" }, + { + "description": "Traffic going into the listed zones will be metered", + "length": 255, + "name": "includezones", + "required": false, + "type": "string" + }, + { + "description": "Traffic going into the listed zones will not be metered", + "length": 255, + "name": "excludezones", + "required": false, + "type": "string" + }, { "description": "URL of the traffic monitor Host", "length": 255, "name": "url", "required": true, "type": "string" - }, - { - "description": "Traffic going into the listed zones will be metered", - "length": 255, - "name": "includezones", - "required": false, - "type": "string" } ], "related": "", "response": [ - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, { "description": "the number of times to retry requests to the external firewall", "name": "numretries", "type": "string" }, - {}, { "description": "the zone ID of the external firewall", "name": "zoneid", "type": "string" }, + {}, + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the ID of the external firewall", + "name": "id", + "type": "string" + }, { "description": "the management IP address of the external firewall", "name": "ipaddress", @@ -78584,16 +80282,10 @@ "name": "timeout", "type": "string" }, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - }, - { - "description": "the ID of the external firewall", - "name": "id", - "type": "string" } ] }, @@ -78603,75 +80295,70 @@ "name": "updateProject", "params": [ { - "description": "ID of the user to be promoted/demoted", + "description": "display text of the project", "length": 255, - "name": "userid", - "related": "createUser,disableUser,enableUser,getUser,listUsers", + "name": "displaytext", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "when true, it swaps ownership with the account/ user provided. Ideally to be used when a single project administrator is present. In case of multiple project admins, swapowner is to be set to false,to promote or demote the user/account based on the roleType (Regular or Admin) provided. Defaults to true", + "description": "Account level role to be assigned to the user/account : Admin/Regular", "length": 255, - "name": "swapowner", + "name": "roletype", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "Account level role to be assigned to the user/account : Admin/Regular", + "description": "new Admin account for the project", "length": 255, - "name": "roletype", + "name": "account", "required": false, "type": "string" }, { - "description": "id of the project to be modified", + "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": "id", - "related": "activateProject,suspendProject,updateProject", - "required": true, - "type": "uuid" + "name": "swapowner", + "required": false, + "type": "boolean" }, { - "description": "new Admin account for the project", + "description": "ID of the user to be promoted/demoted", "length": 255, - "name": "account", + "name": "userid", + "related": "createUser,disableUser,enableUser,getUser,listUsers", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "display text of the project", + "description": "id of the project to be modified", "length": 255, - "name": "displaytext", - "required": false, - "type": "string" + "name": "id", + "related": "activateProject,suspendProject,updateProject", + "required": true, + "type": "uuid" } ], "related": "activateProject,suspendProject", "response": [ { - "description": "the total number of public ip addresses allocated for this project", - "name": "iptotal", + "description": "the total number of cpu cores owned by project", + "name": "cputotal", "type": "long" }, { - "description": "the total number of templates which can be created by this project", - "name": "templatelimit", + "description": "the id of the project", + "name": "id", "type": "string" }, { - "description": "the total memory (in MB) owned by project", - "name": "memorytotal", - "type": "long" - }, - { - "description": "the total secondary storage space (in GiB) available to be used for this project", - "name": "secondarystorageavailable", + "description": "the total number of public ip addresses available for this project to acquire", + "name": "ipavailable", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the total number of snapshots which can be stored by this project", + "name": "snapshotlimit", "type": "string" }, { @@ -78680,63 +80367,68 @@ "type": "long" }, { - "description": "the total number of cpu cores available to be created for this project", - "name": "cpuavailable", - "type": "string" + "description": "the account name of the project's owners", + "name": "owner", + "type": "list" }, { - "description": "the total number of virtual machines deployed by this project", - "name": "vmtotal", - "type": "long" + "description": "the domain name where the project belongs to", + "name": "domain", + "type": "string" }, { - "description": "the total number of cpu cores the project can own", - "name": "cpulimit", + "description": "the total volume which can be used by this project", + "name": "volumelimit", "type": "string" }, { - "description": "the total number of snapshots which can be stored by this project", - "name": "snapshotlimit", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the total number of templates available to be created by this project", - "name": "templateavailable", - "type": "string" + "description": "the total number of virtual machines stopped for this project", + "name": "vmstopped", + "type": "integer" }, { - "description": "the total number of networks available to be created for this project", - "name": "networkavailable", + "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 total memory (in MB) owned by project", + "name": "memorytotal", + "type": "long" }, { - "description": "the total memory (in MB) the project can own", - "name": "memorylimit", - "type": "string" + "description": "the total number of vpcs owned by project", + "name": "vpctotal", + "type": "long" }, { - "description": "the total number of vpcs the project can own", - "name": "vpclimit", - "type": "string" + "description": "the total primary storage space (in GiB) owned by project", + "name": "primarystoragetotal", + "type": "long" }, { - "description": "the total number of virtual machines running for this project", - "name": "vmrunning", - "type": "integer" + "description": "the total number of cpu cores available to be created for this project", + "name": "cpuavailable", + "type": "string" }, { - "description": "the state of the project", - "name": "state", + "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", + "description": "the total number of virtual machines deployed by this project", + "name": "vmtotal", + "type": "long" + }, + { + "description": "the total volume being used by this project", + "name": "volumetotal", "type": "long" }, { @@ -78744,64 +80436,24 @@ "name": "secondarystoragetotal", "type": "float" }, - { - "description": "the name of the project", - "name": "name", - "type": "string" - }, { "description": "the date this project was created", "name": "created", "type": "date" }, - { - "description": "the total number of templates which have been created by this project", - "name": "templatetotal", - "type": "long" - }, { "description": "the total number of snapshots available for this project", "name": "snapshotavailable", "type": "string" }, { - "description": "the id of the project", - "name": "id", - "type": "string" - }, - { - "description": "the total number of vpcs available to be created for this project", - "name": "vpcavailable", - "type": "string" - }, - { - "description": "the displaytext of the project", - "name": "displaytext", - "type": "string" - }, - { - "description": "the account name of the project's owners", - "name": "owner", - "type": "list" - }, - { - "description": "the total primary storage space (in GiB) owned by project", - "name": "primarystoragetotal", - "type": "long" - }, - { - "description": "the total number of virtual machines available for this project to acquire", - "name": "vmavailable", - "type": "string" - }, - { - "description": "the domain name where the project belongs to", - "name": "domain", + "description": "the total secondary storage space (in GiB) available to be used for this project", + "name": "secondarystorageavailable", "type": "string" }, { - "description": "the total number of public ip addresses available for this project to acquire", - "name": "ipavailable", + "description": "the total volume available for this project", + "name": "volumeavailable", "type": "string" }, { @@ -78809,77 +80461,102 @@ "name": "iplimit", "type": "string" }, - {}, { "description": "the list of resource tags associated with vm", "name": "tags", "response": [ { - "description": "customer associated with the tag", - "name": "customer", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the 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": "tag value", - "name": "value", + "description": "resource type", + "name": "resourcetype", "type": "string" } ], "type": "list" }, + { + "description": "the state of the project", + "name": "state", + "type": "string" + }, + { + "description": "the name of the project", + "name": "name", + "type": "string" + }, + { + "description": "the total number of vpcs available to be created for this project", + "name": "vpcavailable", + "type": "string" + }, + { + "description": "the total primary storage space (in GiB) available to be used for this project", + "name": "primarystorageavailable", + "type": "string" + }, + { + "description": "the total number of networks owned by project", + "name": "networktotal", + "type": "long" + }, + {}, { "description": "the domain id the project belongs to", "name": "domainid", "type": "string" }, { - "description": "the 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 primary storage space (in GiB) the project can own", - "name": "primarystoragelimit", + "description": "the project account name of the project", + "name": "projectaccountname", "type": "string" }, { @@ -78887,60 +80564,75 @@ "name": "vmlimit", "type": "string" }, - {}, { - "description": "the total number of networks owned by project", - "name": "networktotal", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the total number of templates which have been created by this project", + "name": "templatetotal", "type": "long" }, { - "description": "the total primary storage space (in GiB) available to be used for this project", - "name": "primarystorageavailable", + "description": "the total number of templates available to be created by this project", + "name": "templateavailable", "type": "string" }, { - "description": "the total volume being used by this project", - "name": "volumetotal", - "type": "long" + "description": "the total memory (in MB) available to be created for this project", + "name": "memoryavailable", + "type": "string" }, { - "description": "the total number of cpu cores owned by project", - "name": "cputotal", + "description": "the total number of public ip addresses allocated for this project", + "name": "iptotal", "type": "long" }, { - "description": "the total volume available for this project", - "name": "volumeavailable", + "description": "the total number of templates which can be created by this project", + "name": "templatelimit", "type": "string" }, { - "description": "the total secondary storage space (in GiB) the project can own", - "name": "secondarystoragelimit", + "description": "the displaytext of the project", + "name": "displaytext", "type": "string" }, { - "description": "the total number of virtual machines stopped for this project", - "name": "vmstopped", + "description": "the total number of networks available to be created for this project", + "name": "networkavailable", + "type": "string" + }, + {}, + { + "description": "the total number of virtual machines running for this project", + "name": "vmrunning", "type": "integer" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the total number of vpcs the project can own", + "name": "vpclimit", + "type": "string" }, { - "description": "the total memory (in MB) available to be created for this project", - "name": "memoryavailable", + "description": "the total primary storage space (in GiB) the project can own", + "name": "primarystoragelimit", "type": "string" }, { - "description": "the project account name of the project", - "name": "projectaccountname", + "description": "the total number of virtual machines available for this project to acquire", + "name": "vmavailable", "type": "string" }, { - "description": "the total volume which can be used by this project", - "name": "volumelimit", + "description": "the total secondary storage space (in GiB) the project can own", + "name": "secondarystoragelimit", "type": "string" } ], @@ -78952,50 +80644,40 @@ "name": "listLoadBalancers", "params": [ { - "description": "the ID of the load balancer", - "length": 255, - "name": "id", - "related": "", - "required": false, - "type": "uuid" - }, - { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", "length": 255, - "name": "isrecursive", + "name": "fordisplay", "required": false, + "since": "4.4", "type": "boolean" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "the source IP address of the load balancer", "length": 255, - "name": "account", + "name": "sourceipaddress", "required": false, "type": "string" }, { - "description": "the network ID of the source IP address", + "description": "", "length": 255, - "name": "sourceipaddressnetworkid", - "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork,listF5LoadBalancerNetworks,listNetscalerLoadBalancerNetworks,listBrocadeVcsDeviceNetworks", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "the network ID of the load balancer", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "networkid", - "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork,listF5LoadBalancerNetworks,listNetscalerLoadBalancerNetworks,listBrocadeVcsDeviceNetworks", + "name": "listall", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "description": "List resources by tags (key/value pairs)", "length": 255, - "name": "fordisplay", + "name": "tags", "required": false, - "since": "4.4", - "type": "boolean" + "type": "map" }, { "description": "the name of the load balancer", @@ -79004,14 +80686,6 @@ "required": false, "type": "string" }, - { - "description": "list only resources belonging to the domain specified", - "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", - "required": false, - "type": "uuid" - }, { "description": "", "length": 255, @@ -79020,19 +80694,20 @@ "type": "integer" }, { - "description": "list objects by project", + "description": "the network ID of the source IP address", "length": 255, - "name": "projectid", - "related": "activateProject,suspendProject", + "name": "sourceipaddressnetworkid", + "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listBrocadeVcsDeviceNetworks", "required": false, "type": "uuid" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false", + "description": "the network ID of the load balancer", "length": 255, - "name": "listall", + "name": "networkid", + "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listBrocadeVcsDeviceNetworks", "required": false, - "type": "boolean" + "type": "uuid" }, { "description": "List by keyword", @@ -79042,11 +80717,12 @@ "type": "string" }, { - "description": "List resources by tags (key/value pairs)", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "tags", + "name": "projectid", + "related": "activateProject,suspendProject", "required": false, - "type": "map" + "type": "uuid" }, { "description": "the scheme of the load balancer. Supported value is internal in the current release", @@ -79056,98 +80732,56 @@ "type": "string" }, { - "description": "the source IP address of the load balancer", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "sourceipaddress", + "name": "domainid", + "related": "listDomainChildren,listDomains", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "", + "description": "the ID of the load balancer", "length": 255, - "name": "page", + "name": "id", + "related": "updateIpv6FirewallRule", "required": false, - "type": "integer" - } - ], - "related": "createLoadBalancer", - "response": [ + "type": "uuid" + }, { - "description": "is rule 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 account of the Load Balancer", + "description": "list resources by account. Must be used with the domainId parameter.", + "length": 255, "name": "account", + "required": false, "type": "string" - }, + } + ], + "related": "createLoadBalancer", + "response": [ { "description": "Load Balancer source ip", "name": "sourceipaddress", "type": "string" }, { - "description": "the list of resource tags associated with the Load Balancer", - "name": "tags", - "response": [ - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - } - ], - "type": "list" + "description": "the name of the Load Balancer", + "name": "name", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the Load Balancer ID", - "name": "id", + "description": "the domain ID of the Load Balancer", + "name": "domainid", "type": "string" }, { @@ -79160,13 +80794,13 @@ "type": "string" }, { - "description": "the instance ID", - "name": "id", + "description": "the ip address of the instance", + "name": "ipaddress", "type": "string" }, { - "description": "the ip address of the instance", - "name": "ipaddress", + "description": "the instance ID", + "name": "id", "type": "string" }, { @@ -79177,20 +80811,24 @@ ], "type": "list" }, + { + "description": "the description of the Load Balancer", + "name": "description", + "type": "string" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the project name of the Load Balancer", - "name": "project", + "description": "Load Balancer network id", + "name": "networkid", "type": "string" }, - {}, { - "description": "the domain of the Load Balancer", - "name": "domain", + "description": "Load Balancer source ip network id", + "name": "sourceipaddressnetworkid", "type": "string" }, { @@ -79215,44 +80853,98 @@ ], "type": "list" }, + {}, { - "description": "Load Balancer source ip network id", - "name": "sourceipaddressnetworkid", + "description": "the project id of the Load Balancer", + "name": "projectid", "type": "string" }, { - "description": "the load balancer algorithm (source, roundrobin, leastconn)", - "name": "algorithm", + "description": "the account of the Load Balancer", + "name": "account", "type": "string" }, { - "description": "the name of the Load Balancer", - "name": "name", - "type": "string" + "description": "is rule for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, { - "description": "the domain ID of the Load Balancer", - "name": "domainid", + "description": "the load balancer algorithm (source, roundrobin, leastconn)", + "name": "algorithm", "type": "string" }, + {}, { - "description": "the description of the Load Balancer", - "name": "description", + "description": "the domain of the Load Balancer", + "name": "domain", "type": "string" }, { - "description": "Load Balancer network id", - "name": "networkid", - "type": "string" + "description": "the list of resource tags associated with the Load Balancer", + "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": "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 account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + } + ], + "type": "list" }, { - "description": "the project id of the Load Balancer", - "name": "projectid", + "description": "the Load Balancer ID", + "name": "id", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the project name of the Load Balancer", + "name": "project", "type": "string" } ], @@ -79264,11 +80956,19 @@ "name": "listUsers", "params": [ { - "description": "List users by account type. Valid types include admin, domain-admin, read-only-admin, or user.", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "accounttype", + "name": "isrecursive", "required": false, - "type": "long" + "type": "boolean" + }, + { + "description": "List user by ID.", + "length": 255, + "name": "id", + "related": "createUser,disableUser,enableUser,getUser,listUsers", + "required": false, + "type": "uuid" }, { "description": "", @@ -79278,25 +80978,26 @@ "type": "integer" }, { - "description": "List user by the username", + "description": "List by keyword", "length": 255, - "name": "username", + "name": "keyword", "required": false, "type": "string" }, { - "description": "List by keyword", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "keyword", + "name": "account", "required": false, "type": "string" }, { - "description": "flag to display the resource icon for users", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "showicon", + "name": "domainid", + "related": "listDomainChildren,listDomains", "required": false, - "type": "boolean" + "type": "uuid" }, { "description": "", @@ -79306,46 +81007,37 @@ "type": "integer" }, { - "description": "List users by state of the user account.", + "description": "List users by account type. Valid types include admin, domain-admin, read-only-admin, or user.", "length": 255, - "name": "state", + "name": "accounttype", "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", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller 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.", + "description": "List users by state of the user account.", "length": 255, - "name": "account", + "name": "state", "required": false, "type": "string" }, { - "description": "List user by ID.", - "length": 255, - "name": "id", - "related": "createUser,disableUser,enableUser,getUser,listUsers", - "required": false, - "type": "uuid" - }, - { - "description": "list only resources belonging to the domain specified", + "description": "List user by the username", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", + "name": "username", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "flag to display the resource icon for users", "length": 255, - "name": "isrecursive", + "name": "showicon", "required": false, "type": "boolean" } @@ -79353,34 +81045,59 @@ "related": "createUser,disableUser,enableUser,getUser", "response": [ { - "description": "the user state", - "name": "state", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the user lastname", - "name": "lastname", + "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 ID", + "name": "id", + "type": "string" + }, + { + "description": "the user name", + "name": "username", "type": "string" }, {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "the timezone user was created in", "name": "timezone", "type": "string" }, { - "description": "the source type of the user in lowercase, such as native, ldap, saml2", - "name": "usersource", + "description": "the date and time the user account was created", + "name": "created", + "type": "date" + }, + { + "description": "the type of the role", + "name": "roletype", "type": "string" }, { - "description": "the account ID of the user", - "name": "accountid", + "description": "the domain name of the user", + "name": "domain", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the account ID of the user", + "name": "accountid", "type": "string" }, { @@ -79389,18 +81106,23 @@ "type": "string" }, { - "description": "the account type of the user", - "name": "accounttype", - "type": "short" + "description": "the user lastname", + "name": "lastname", + "type": "string" }, { - "description": "the domain ID of the user", - "name": "domainid", + "description": "the source type of the user in lowercase, such as native, ldap, saml2", + "name": "usersource", "type": "string" }, { - "description": "the name of the role", - "name": "rolename", + "description": "the secret key of the user", + "name": "secretkey", + "type": "string" + }, + { + "description": "the domain ID of the user", + "name": "domainid", "type": "string" }, { @@ -79409,24 +81131,24 @@ "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "the account type of the user", + "name": "accounttype", "type": "integer" }, { - "description": "the user ID", - "name": "id", + "description": "the api key of the user", + "name": "apikey", "type": "string" }, {}, { - "description": "the date and time the user account was created", - "name": "created", - "type": "date" + "description": "the user state", + "name": "state", + "type": "string" }, { - "description": "the user name", - "name": "username", + "description": "the ID of the role", + "name": "roleid", "type": "string" }, { @@ -79434,44 +81156,14 @@ "name": "icon", "type": "resourceiconresponse" }, - { - "description": "the secret key of the user", - "name": "secretkey", - "type": "string" - }, - { - "description": "the domain name of the user", - "name": "domain", - "type": "string" - }, - { - "description": "the type of the role", - "name": "roletype", - "type": "string" - }, { "description": "the user firstname", "name": "firstname", "type": "string" }, { - "description": "the api key of the user", - "name": "apikey", - "type": "string" - }, - { - "description": "true if user is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "the boolean value representing if the updating target is in caller's child domain", - "name": "iscallerchilddomain", - "type": "boolean" - }, - { - "description": "the ID of the role", - "name": "roleid", + "description": "the name of the role", + "name": "rolename", "type": "string" } ] @@ -79493,13 +81185,13 @@ "related": "", "response": [ { - "description": "the api key of the registered user", - "name": "apikey", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the secret key of the registered user", - "name": "secretkey", + "description": "the api key of the registered user", + "name": "apikey", "type": "string" }, { @@ -79508,12 +81200,12 @@ "type": "string" }, {}, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - } + "description": "the secret key of the registered user", + "name": "secretkey", + "type": "string" + }, + {} ] }, { @@ -79532,27 +81224,27 @@ ], "response": [ { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + {}, + {}, { - "description": "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" }, @@ -79562,37 +81254,45 @@ "name": "updateVlanIpRange", "params": [ { - "description": "true if IP range is set to system vms, false if not", + "description": "the beginning IP address in the VLAN IP range", "length": 255, - "name": "forsystemvms", + "name": "startip", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "the CIDR of IPv6 network, must be at least /64", + "description": "the ending IP address in the VLAN IP range", "length": 255, - "name": "ip6cidr", + "name": "endip", "required": false, "type": "string" }, { - "description": "the ending IPv6 address in the IPv6 network range", + "description": "true if IP range is set to system vms, false if not", "length": 255, - "name": "endipv6", + "name": "forsystemvms", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "the netmask of the VLAN IP range", + "description": "the beginning IPv6 address in the IPv6 network range", "length": 255, - "name": "netmask", + "name": "startipv6", "required": false, "type": "string" }, { - "description": "the ending IP address in the VLAN IP range", + "description": "the UUID of the VLAN IP range", "length": 255, - "name": "endip", + "name": "id", + "related": "updateVlanIpRange,dedicatePublicIpRange", + "required": true, + "type": "uuid" + }, + { + "description": "the CIDR of IPv6 network, must be at least /64", + "length": 255, + "name": "ip6cidr", "required": false, "type": "string" }, @@ -79604,31 +81304,23 @@ "type": "string" }, { - "description": "the beginning IPv6 address in the IPv6 network range", + "description": "the netmask of the VLAN IP range", "length": 255, - "name": "startipv6", + "name": "netmask", "required": false, "type": "string" }, { - "description": "the beginning IP address in the VLAN IP range", + "description": "the gateway of the VLAN IP range", "length": 255, - "name": "startip", + "name": "gateway", "required": false, "type": "string" }, { - "description": "the UUID of the VLAN IP range", - "length": 255, - "name": "id", - "related": "updateVlanIpRange,dedicatePublicIpRange", - "required": true, - "type": "uuid" - }, - { - "description": "the gateway of the VLAN IP range", + "description": "the ending IPv6 address in the IPv6 network range", "length": 255, - "name": "gateway", + "name": "endipv6", "required": false, "type": "string" } @@ -79636,8 +81328,18 @@ "related": "dedicatePublicIpRange", "response": [ { - "description": "the end ip of the VLAN IP range", - "name": "endip", + "description": "the project id of the vlan range", + "name": "projectid", + "type": "string" + }, + { + "description": "the Pod name for the VLAN IP range", + "name": "podname", + "type": "string" + }, + { + "description": "the domain name of the VLAN IP range", + "name": "domain", "type": "string" }, { @@ -79646,58 +81348,59 @@ "type": "string" }, { - "description": "the gateway of the VLAN IP range", - "name": "gateway", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "the Zone ID of the VLAN IP range", - "name": "zoneid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the Pod ID for the VLAN IP range", + "name": "podid", + "type": "string" }, { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", + "description": "the netmask of the VLAN IP range", + "name": "netmask", "type": "string" }, + {}, { - "description": "the description of the VLAN IP range", - "name": "description", + "description": "the start ipv6 of the VLAN IP range", + "name": "startipv6", "type": "string" }, { - "description": "the domain name of the VLAN IP range", - "name": "domain", + "description": "the description of the VLAN IP range", + "name": "description", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "the start ip of the VLAN IP range", + "name": "startip", "type": "string" }, { - "description": "the account of the VLAN IP range", - "name": "account", - "type": "string" + "description": "the virtual network for the VLAN IP range", + "name": "forvirtualnetwork", + "type": "boolean" }, { - "description": "the project id of the vlan range", - "name": "projectid", + "description": "the end ip of the VLAN IP range", + "name": "endip", "type": "string" }, { - "description": "the Pod ID for the VLAN IP range", - "name": "podid", + "description": "the end ipv6 of the VLAN IP range", + "name": "endipv6", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the network id of vlan range", + "name": "networkid", "type": "string" }, { @@ -79706,39 +81409,34 @@ "type": "string" }, { - "description": "the start ipv6 of the VLAN IP range", - "name": "startipv6", + "description": "the Zone ID of the VLAN IP range", + "name": "zoneid", "type": "string" }, + {}, { - "description": "the start ip of the VLAN IP range", - "name": "startip", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "the virtual network for the VLAN IP range", - "name": "forvirtualnetwork", + "description": "indicates whether VLAN IP range is dedicated to system vms or not", + "name": "forsystemvms", "type": "boolean" }, { - "description": "the domain ID of the VLAN IP range", - "name": "domainid", - "type": "string" - }, - { - "description": "the netmask of the VLAN IP range", - "name": "netmask", + "description": "the gateway of the VLAN IP range", + "name": "gateway", "type": "string" }, { - "description": "the network id of vlan range", - "name": "networkid", + "description": "the cidr of the VLAN IP range", + "name": "cidr", "type": "string" }, - {}, { - "description": "the end ipv6 of the VLAN IP range", - "name": "endipv6", + "description": "the account of the VLAN IP range", + "name": "account", "type": "string" }, { @@ -79746,21 +81444,20 @@ "name": "id", "type": "string" }, - {}, { - "description": "indicates whether VLAN IP range is dedicated to system vms or not", - "name": "forsystemvms", - "type": "boolean" + "description": "the domain ID of the VLAN IP range", + "name": "domainid", + "type": "string" }, { - "description": "the Pod name for the VLAN IP range", - "name": "podname", + "description": "the physical network this belongs to", + "name": "physicalnetworkid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ], "since": "4.16.0" @@ -79771,11 +81468,10 @@ "name": "listVpnConnections", "params": [ { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "fordisplay", + "name": "isrecursive", "required": false, - "since": "4.4", "type": "boolean" }, { @@ -79794,20 +81490,28 @@ "type": "uuid" }, { - "description": "list only resources belonging to the domain specified", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", + "name": "projectid", + "related": "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", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, "name": "listall", "required": false, "type": "boolean" }, + { + "description": "id of vpc", + "length": 255, + "name": "vpcid", + "related": "createVPC,listVPCs,updateVPC,migrateVPC", + "required": false, + "type": "uuid" + }, { "description": "", "length": 255, @@ -79816,25 +81520,25 @@ "type": "integer" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", "length": 255, - "name": "isrecursive", + "name": "fordisplay", "required": false, + "since": "4.4", "type": "boolean" }, { - "description": "list objects by project", + "description": "List by keyword", "length": 255, - "name": "projectid", - "related": "activateProject,suspendProject", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "id of vpc", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "vpcid", - "related": "createVPC,listVPCs,updateVPC,migrateVPC", + "name": "domainid", + "related": "listDomainChildren,listDomains", "required": false, "type": "uuid" }, @@ -79844,57 +81548,64 @@ "name": "page", "required": false, "type": "integer" - }, - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" } ], "related": "createVpnConnection", "response": [ { - "description": "if Force NAT Encapsulation is enabled for customer gateway", - "name": "forceencap", - "type": "boolean" + "description": "public ip address id of the customer gateway", + "name": "gateway", + "type": "string" }, { - "description": "the domain id of the owner", - "name": "domainid", + "description": "IKE policy of the customer gateway", + "name": "ikepolicy", "type": "string" }, { - "description": "the project name", - "name": "project", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the project id", - "name": "projectid", + "description": "IPsec Preshared-Key of the customer gateway", + "name": "ipsecpsk", "type": "string" }, { - "description": "the owner", - "name": "account", + "description": "State of vpn connection", + "name": "state", "type": "string" }, { - "description": "public ip address id of the customer gateway", - "name": "gateway", + "description": "Split multiple remote networks into multiple phase 2 SAs. Often used with Cisco some products.", + "name": "splitconnections", + "type": "boolean" + }, + { + "description": "Lifetime of IKE SA of customer gateway", + "name": "ikelifetime", + "type": "long" + }, + { + "description": "if DPD is enabled for customer gateway", + "name": "dpd", + "type": "boolean" + }, + { + "description": "the customer gateway ID", + "name": "s2scustomergatewayid", "type": "string" }, { - "description": "the connection ID", - "name": "id", + "description": "the domain name of the owner", + "name": "domain", "type": "string" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "is connection for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, { "description": "Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Defaults to ike", @@ -79902,34 +81613,29 @@ "type": "string" }, { - "description": "the public IP address", - "name": "publicip", + "description": "the project id", + "name": "projectid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "ESP policy of the customer gateway", + "name": "esppolicy", "type": "string" }, - {}, - { - "description": "State of vpn connection", - "name": "passive", - "type": "boolean" - }, { - "description": "the vpn gateway ID", - "name": "s2svpngatewayid", + "description": "the domain id of the owner", + "name": "domainid", "type": "string" }, { - "description": "IPsec Preshared-Key of the customer gateway", - "name": "ipsecpsk", - "type": "string" + "description": "the date and time the host was created", + "name": "created", + "type": "date" }, + {}, { - "description": "IKE policy of the customer gateway", - "name": "ikepolicy", + "description": "the owner", + "name": "account", "type": "string" }, { @@ -79938,58 +81644,49 @@ "type": "long" }, { - "description": "the domain name of the owner", - "name": "domain", + "description": "the connection ID", + "name": "id", "type": "string" }, { - "description": "State of vpn connection", - "name": "state", + "description": "the public IP address", + "name": "publicip", "type": "string" }, { - "description": "is connection for display to the regular user", - "name": "fordisplay", + "description": "State of vpn connection", + "name": "passive", "type": "boolean" }, { - "description": "Lifetime of IKE SA of customer gateway", - "name": "ikelifetime", - "type": "long" + "description": "the project name", + "name": "project", + "type": "string" }, { - "description": "Split multiple remote networks into multiple phase 2 SAs. Often used with Cisco some products.", - "name": "splitconnections", + "description": "if Force NAT Encapsulation is enabled for customer gateway", + "name": "forceencap", "type": "boolean" }, - { - "description": "guest cidr list of the customer gateway. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", - "type": "string" - }, { "description": "the date and time the host was removed", "name": "removed", "type": "date" }, { - "description": "if DPD is enabled for customer gateway", - "name": "dpd", - "type": "boolean" - }, - { - "description": "the date and time the host was created", - "name": "created", - "type": "date" + "description": "guest cidr list of the customer gateway. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", + "type": "string" }, + {}, { - "description": "ESP policy of the customer gateway", - "name": "esppolicy", + "description": "the vpn gateway ID", + "name": "s2svpngatewayid", "type": "string" }, { - "description": "the customer gateway ID", - "name": "s2scustomergatewayid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" } ] @@ -80000,103 +81697,92 @@ "name": "listResourceLimits", "params": [ { - "description": "Type of resource (wins over resourceType if both are provided). Values are: user_vm - Instance. Number of instances a user can create. public_ip - IP. Number of public IP addresses an account can own. volume - Volume. Number of disk volumes an account can own. snapshot - Snapshot. Number of snapshots an account can own. template - Template. Number of templates an account can register/create. project - Project. Number of projects an account can own. network - Network. Number of networks an account can own. vpc - VPC. Number of VPC an account can own. cpu - CPU. Number of CPU an account can allocate for their resources. memory - Memory. Amount of RAM an account can allocate for their resources. primary_storage - PrimaryStorage. Total primary storage space (in GiB) a user can use. secondary_storage - SecondaryStorage. Total secondary storage space (in GiB) a user can use. ", + "description": "", "length": 255, - "name": "resourcetypename", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { - "description": "Lists resource limits by ID.", + "description": "Type of resource. Values are 0, 1, 2, 3, 4, 6, 7, 8, 9, 10 and 11. 0 - Instance. Number of instances a user can create. 1 - IP. Number of public IP addresses an account can own. 2 - Volume. Number of disk volumes an account can own. 3 - Snapshot. Number of snapshots an account can own. 4 - Template. Number of templates an account can register/create. 5 - Project. Number of projects an account can own. 6 - Network. Number of networks an account can own. 7 - VPC. Number of VPC an account can own. 8 - CPU. Number of CPU an account can allocate for their resources. 9 - Memory. Amount of RAM an account can allocate for their resources. 10 - PrimaryStorage. Total primary storage space (in GiB) a user can use. 11 - SecondaryStorage. Total secondary storage space (in GiB) a user can use. ", "length": 255, - "name": "id", + "name": "resourcetype", "required": false, - "type": "long" + "type": "integer" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "isrecursive", + "name": "listall", "required": false, "type": "boolean" }, { - "description": "List by keyword", + "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": "keyword", + "name": "resourcetypename", "required": false, "type": "string" }, { - "description": "list objects by project", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "projectid", - "related": "activateProject,suspendProject", + "name": "isrecursive", "required": false, - "type": "uuid" + "type": "boolean" }, { - "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": "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": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "resourcetype", + "name": "projectid", + "related": "activateProject,suspendProject", "required": false, - "type": "integer" + "type": "uuid" }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, { - "description": "list only resources belonging to the domain specified", + "description": "List by keyword", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "Lists resource limits by ID.", "length": 255, - "name": "account", + "name": "id", "required": false, - "type": "string" + "type": "long" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false", + "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": "the maximum number of the resource. A -1 means the resource currently has no limit.", - "name": "max", - "type": "long" - }, - { - "description": "the domain ID of the resource limit", - "name": "domainid", - "type": "string" - }, - { - "description": "resource type name. Values include user_vm, public_ip, volume, snapshot, template, project, network, vpc, cpu, memory, primary_storage, secondary_storage.", - "name": "resourcetypename", + "description": "the project name of the resource limit", + "name": "project", "type": "string" }, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", @@ -80108,31 +81794,42 @@ "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", - "type": "string" + "description": "the maximum number of the resource. A -1 means the resource currently has no limit.", + "name": "max", + "type": "long" }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + { + "description": "the domain ID of the resource limit", + "name": "domainid", + "type": "string" + }, + { + "description": "resource type name. Values include user_vm, public_ip, volume, snapshot, template, project, network, vpc, cpu, memory, primary_storage, secondary_storage.", + "name": "resourcetypename", + "type": "string" + }, {}, { - "description": "the domain name of the resource limit", - "name": "domain", + "description": "resource type. Values include 0, 1, 2, 3, 4, 6, 7, 8, 9, 10, 11. See the resourceType parameter for more information on these values.", + "name": "resourcetype", "type": "string" }, { - "description": "the project name of the resource limit", - "name": "project", + "description": "the domain name of the resource limit", + "name": "domain", "type": "string" }, { "description": "the account of the resource limit", "name": "account", "type": "string" - } + }, + {} ] }, { @@ -80153,63 +81850,68 @@ "response": [ {}, { - "description": "the type of the role", - "name": "roletype", + "description": "the api key of the user", + "name": "apikey", "type": "string" }, { - "description": "the user state", - "name": "state", + "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", + "description": "the ID of the role", + "name": "roleid", "type": "string" }, { - "description": "the account type of the user", - "name": "accounttype", - "type": "short" + "description": "true if user is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "the ID of the role", - "name": "roleid", + "description": "the domain name of the user", + "name": "domain", "type": "string" }, { - "description": "the user ID", - "name": "id", + "description": "the user lastname", + "name": "lastname", "type": "string" }, { - "description": "the user email address", - "name": "email", - "type": "string" + "description": "the date and time the user account was created", + "name": "created", + "type": "date" }, { - "description": "the user firstname", - "name": "firstname", - "type": "string" + "description": "the account type of the user", + "name": "accounttype", + "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the account name of the user", + "name": "account", "type": "string" }, { - "description": "the timezone user was created in", - "name": "timezone", + "description": "the account ID of the user", + "name": "accountid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the boolean value representing if the updating target is in caller's child domain", + "name": "iscallerchilddomain", + "type": "boolean" }, { - "description": "the name of the role", - "name": "rolename", + "description": "the domain ID of the user", + "name": "domainid", + "type": "string" + }, + { + "description": "the user state", + "name": "state", "type": "string" }, { @@ -80218,59 +81920,54 @@ "type": "string" }, { - "description": "the domain ID of the user", - "name": "domainid", + "description": "the user firstname", + "name": "firstname", "type": "string" }, { - "description": "true if user is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the account name of the user", - "name": "account", + "description": "the type of the role", + "name": "roletype", "type": "string" }, { - "description": "the user lastname", - "name": "lastname", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the secret key of the user", - "name": "secretkey", + "description": "the user ID", + "name": "id", "type": "string" }, { - "description": "the date and time the user account was created", - "name": "created", - "type": "date" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the domain name of the user", - "name": "domain", + "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 api key of the user", - "name": "apikey", + "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 source type of the user in lowercase, such as native, ldap, saml2", + "name": "usersource", + "type": "string" }, { - "description": "the account ID of the user", - "name": "accountid", + "description": "the name of the role", + "name": "rolename", "type": "string" } ] @@ -80281,20 +81978,12 @@ "name": "listIsos", "params": [ { - "description": "true if the ISO is bootable, false otherwise", + "description": "true if the ISO is publicly available to all users, false otherwise.", "length": 255, - "name": "bootable", + "name": "ispublic", "required": false, "type": "boolean" }, - { - "description": "the ID of the zone", - "length": 255, - "name": "zoneid", - "related": "createZone,listZones,listZones", - "required": false, - "type": "uuid" - }, { "description": "List resources by tags (key/value pairs)", "length": 255, @@ -80303,72 +81992,74 @@ "type": "map" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "account", + "name": "isrecursive", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "", + "description": "list ISO by ID", "length": 255, - "name": "page", + "name": "id", + "related": "listIsos,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "the hypervisor for which to restrict the search", + "description": "true if this ISO is ready to be deployed", "length": 255, - "name": "hypervisor", + "name": "isready", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "list all ISOs by 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", + "name": "isofilter", "required": false, "type": "string" }, { - "description": "true if the ISO is publicly available to all users, false otherwise.", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "ispublic", + "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", + "description": "show removed ISOs as well", "length": 255, - "name": "listall", + "name": "showremoved", "required": false, "type": "boolean" }, { - "description": "", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "pagesize", + "name": "projectid", + "related": "activateProject,suspendProject", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "true if this ISO is ready to be deployed", + "description": "true if the ISO is bootable, false otherwise", "length": 255, - "name": "isready", + "name": "bootable", "required": false, "type": "boolean" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "List by keyword", "length": 255, - "name": "isrecursive", + "name": "keyword", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "List by keyword", + "description": "list all ISOs by name", "length": 255, - "name": "keyword", + "name": "name", "required": false, "type": "string" }, @@ -80381,91 +82072,143 @@ "type": "boolean" }, { - "description": "possible values are \"featured\", \"self\", \"selfexecutable\",\"sharedexecutable\",\"executable\", and \"community\". * featured : templates that have been marked as featured and public. * self : templates that have been registered or created by the calling user. * selfexecutable : same as self, but only returns templates that can be used to deploy a new VM. * sharedexecutable : templates ready to be deployed that have been granted to the calling user by another user. * executable : templates that are owned by the calling user, or public templates, that can be used to deploy a VM. * community : templates that have been marked as public but not featured. * all : all templates (only usable by admins).", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "isofilter", + "name": "listall", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "show removed ISOs as well", + "description": "flag to display the resource image for the isos", "length": 255, - "name": "showremoved", + "name": "showicon", "required": false, "type": "boolean" }, { - "description": "list objects by project", + "description": "the hypervisor for which to restrict the search", "length": 255, - "name": "projectid", - "related": "activateProject,suspendProject", + "name": "hypervisor", + "required": false, + "type": "string" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "description": "list only resources belonging to the domain specified", + "length": 255, + "name": "domainid", + "related": "listDomainChildren,listDomains", "required": false, "type": "uuid" }, { - "description": "list ISO by ID", + "description": "", "length": 255, - "name": "id", - "related": "listIsos,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", + "name": "page", + "required": false, + "type": "integer" + }, + { + "description": "the ID of the zone", + "length": 255, + "name": "zoneid", + "related": "createZone,listZones,listZones", "required": false, "type": "uuid" + } + ], + "related": "registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", + "response": [ + { + "description": "the name of the domain to which the template belongs", + "name": "domain", + "type": "string" + }, + { + "description": "VMware only: additional key/value details tied with deploy-as-is template", + "name": "deployasisdetails", + "type": "map" + }, + { + "description": "the ID of the secondary storage host for the template", + "name": "hostid", + "type": "string" + }, + { + "description": "the ID of the zone for this template", + "name": "zoneid", + "type": "string" + }, + { + "description": "the date this template was removed", + "name": "removed", + "type": "date" + }, + { + "description": "the name of the OS type for this template.", + "name": "ostypename", + "type": "string" + }, + { + "description": "the type of the template", + "name": "templatetype", + "type": "string" }, { - "description": "list only resources belonging to the domain specified", - "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", - "required": false, - "type": "uuid" + "description": "true if the template is managed across all Zones, false otherwise", + "name": "crossZones", + "type": "boolean" }, { - "description": "flag to display the resource image for the isos", - "length": 255, - "name": "showicon", - "required": false, - "type": "boolean" - } - ], - "related": "registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", - "response": [ + "description": "Lists the download progress of a template across all secondary storages", + "name": "downloaddetails", + "type": "list" + }, { - "description": "the name of the secondary storage host for the template", - "name": "hostname", - "type": "string" + "description": "true if 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 URL which the template/iso is registered from", + "name": "url", "type": "string" }, { - "description": "true if the template is extractable, false otherwise", - "name": "isextractable", + "description": "true if template requires HVM enabled, false otherwise", + "name": "requireshvm", "type": "boolean" }, { - "description": "the template ID of the parent template if present", - "name": "sourcetemplateid", + "description": "the project id of the template", + "name": "projectid", "type": "string" }, { - "description": "the template name", - "name": "name", + "description": "the template display text", + "name": "displaytext", "type": "string" }, + {}, { - "description": "the project id of the template", - "name": "projectid", + "description": "the template ID", + "name": "id", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the template ID of the parent template if present", + "name": "sourcetemplateid", + "type": "string" }, { - "description": "the template display text", - "name": "displaytext", + "description": "the account id to which the template belongs", + "name": "accountid", "type": "string" }, { @@ -80473,14 +82216,39 @@ "name": "ispublic", "type": "boolean" }, + { + "description": "the date this template was created", + "name": "created", + "type": "date" + }, + { + "description": "the tag of this template", + "name": "templatetag", + "type": "string" + }, { "description": "the status of the template", "name": "status", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the format of the template.", + "name": "format", + "type": "imageformat" + }, + { + "description": "the size of the template", + "name": "size", + "type": "long" + }, + { + "description": "true if template is sshkey enabled, false otherwise", + "name": "sshkeyenabled", + "type": "boolean" + }, + { + "description": "the project name of the template", + "name": "project", "type": "string" }, { @@ -80488,18 +82256,13 @@ "name": "tags", "response": [ { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { @@ -80508,18 +82271,13 @@ "type": "string" }, { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { @@ -80533,43 +82291,28 @@ "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", "type": "string" } ], "type": "set" }, { - "description": "the name of the domain to which the template belongs", - "name": "domain", - "type": "string" - }, - { - "description": "the date this template was created", - "name": "created", - "type": "date" - }, - { - "description": "true if template is sshkey enabled, false otherwise", - "name": "sshkeyenabled", - "type": "boolean" - }, - { - "description": "the size of the template", - "name": "size", - "type": "long" - }, - { - "description": "the project name of the template", - "name": "project", + "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 ID of the domain to which the template belongs", "name": "domainid", @@ -80581,19 +82324,19 @@ "type": "boolean" }, { - "description": "the date this template was removed", - "name": "removed", - "type": "date" + "description": "the processor bit size", + "name": "bits", + "type": "int" }, { - "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": "checksum of the template", - "name": "checksum", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { "description": "the name of the zone for this template", @@ -80601,31 +82344,19 @@ "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 physical size of the template", - "name": "physicalsize", - "type": "long" + "description": "additional key/value details tied with template", + "name": "details", + "type": "map" }, { - "description": "the account name to which the template belongs", - "name": "account", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the ID of the OS type for this template.", - "name": "ostypeid", - "type": "string" + "description": "true if the ISO is bootable, false otherwise", + "name": "bootable", + "type": "boolean" }, { "description": "if Datadisk template, then id of the root disk template this template belongs to", @@ -80633,13 +82364,13 @@ "type": "string" }, { - "description": "the processor bit size", - "name": "bits", - "type": "int" + "description": "checksum of the template", + "name": "checksum", + "type": "string" }, { - "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", - "name": "directdownload", + "description": "VMware only: true if template is deployed without orchestrating disks and networks but \"as-is\" defined in the template.", + "name": "deployasis", "type": "boolean" }, { @@ -80648,29 +82379,20 @@ "type": "boolean" }, { - "description": "the format of the template.", - "name": "format", - "type": "imageformat" - }, - { - "description": "true if the ISO is bootable, false otherwise", - "name": "bootable", - "type": "boolean" - }, - { - "description": "the account id to which the template belongs", - "name": "accountid", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the name of the OS type for this template.", - "name": "ostypename", - "type": "string" + "description": "the physical size of the template", + "name": "physicalsize", + "type": "long" }, + {}, { - "description": "VMware only: additional key/value details tied with deploy-as-is template", - "name": "deployasisdetails", - "type": "map" + "description": "if root disk template, then ids of the datas disk templates this template owns", + "name": "childtemplates", + "type": "set" }, { "description": "true if this template is a featured template, false otherwise", @@ -80678,59 +82400,34 @@ "type": "boolean" }, { - "description": "true if template requires HVM enabled, false otherwise", - "name": "requireshvm", - "type": "boolean" - }, - { - "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", + "description": "true if the template is extractable, false otherwise", + "name": "isextractable", "type": "boolean" }, { - "description": "the URL which the template/iso is registered from", - "name": "url", + "description": "the ID of the OS type for this template.", + "name": "ostypeid", "type": "string" }, { - "description": "true if the reset password feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" - }, - { - "description": "Lists the download progress of a template across all secondary storages", - "name": "downloaddetails", - "type": "list" - }, - { - "description": "the ID of the zone for this template", - "name": "zoneid", + "description": "the account name to which the template belongs", + "name": "account", "type": "string" }, { - "description": "additional key/value details tied with template", - "name": "details", - "type": "map" - }, - { - "description": "the ID of the secondary storage host for the template", - "name": "hostid", + "description": "the name of the secondary storage host for the template", + "name": "hostname", "type": "string" }, { - "description": "the template ID", - "name": "id", - "type": "string" + "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", + "name": "directdownload", + "type": "boolean" }, { - "description": "the tag of this template", - "name": "templatetag", - "type": "string" + "description": "true if the reset password feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" } ] }, @@ -80746,6 +82443,13 @@ "required": true, "type": "string" }, + { + "description": "the name for the image store", + "length": 255, + "name": "name", + "required": false, + "type": "string" + }, { "description": "the details for the image store. Example: details[0].key=accesskey&details[0].value=s389ddssaa&details[1].key=secretkey&details[1].value=8dshfsss", "length": 255, @@ -80759,71 +82463,49 @@ "name": "url", "required": false, "type": "string" - }, - { - "description": "the name for the image store", - "length": 255, - "name": "name", - "required": false, - "type": "string" } ], "related": "listSwifts,addImageStoreS3,listImageStores", "response": [ { - "description": "the ID of the image store", - "name": "id", - "type": "string" - }, - { - "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 scope of the image store", "name": "scope", "type": "scopetype" }, + { + "description": "the protocol of the image store", + "name": "protocol", + "type": "string" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the host's currently used disk size", - "name": "disksizeused", + "description": "the total disk size of the host", + "name": "disksizetotal", "type": "long" }, - { - "description": "the protocol of the image store", - "name": "protocol", - "type": "string" - }, - { - "description": "defines if store is read-only", - "name": "readonly", - "type": "boolean" - }, { "description": "the 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 name of the image store", - "name": "name", + "description": "the Zone ID of the image store", + "name": "zoneid", "type": "string" }, {}, { - "description": "the Zone ID of the image store", - "name": "zoneid", + "description": "the ID of the image store", + "name": "id", "type": "string" }, { @@ -80831,16 +82513,31 @@ "name": "zonename", "type": "string" }, - {}, { - "description": "the total disk size of the host", - "name": "disksizetotal", - "type": "long" + "description": "the provider name of the image store", + "name": "providername", + "type": "string" }, { "description": "true if the entity/resource has annotations", "name": "hasannotations", "type": "boolean" + }, + { + "description": "the host's currently used disk size", + "name": "disksizeused", + "type": "long" + }, + {}, + { + "description": "the name of the image store", + "name": "name", + "type": "string" + }, + { + "description": "the url of the image store", + "name": "url", + "type": "string" } ], "since": "4.3.0" @@ -80851,34 +82548,18 @@ "name": "listAutoScalePolicies", "params": [ { - "description": "list only resources belonging to the domain specified", - "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", - "required": false, - "type": "uuid" - }, - { - "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", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, "name": "listall", "required": false, "type": "boolean" }, { - "description": "the ID of the autoscale policy", + "description": "", "length": 255, - "name": "id", - "related": "listAutoScalePolicies", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" }, { "description": "the ID of the autoscale vm group", @@ -80888,13 +82569,6 @@ "required": false, "type": "uuid" }, - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - }, { "description": "the action to be executed if all the conditions evaluate to true for the specified duration.", "length": 255, @@ -80910,6 +82584,14 @@ "required": false, "type": "uuid" }, + { + "description": "list only resources belonging to the domain specified", + "length": 255, + "name": "domainid", + "related": "listDomainChildren,listDomains", + "required": false, + "type": "uuid" + }, { "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, @@ -80924,10 +82606,25 @@ "required": false, "type": "string" }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + }, + { + "description": "the ID of the autoscale policy", + "length": 255, + "name": "id", + "related": "listAutoScalePolicies", + "required": false, + "type": "uuid" + }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" } @@ -80935,28 +82632,33 @@ "related": "", "response": [ { - "description": "the domain ID of the autoscale policy", - "name": "domainid", + "description": "the autoscale policy ID", + "name": "id", "type": "string" }, { - "description": "the project name of the autoscale policy", - "name": "project", + "description": "the duration for which the conditions have to be true before action is taken", + "name": "duration", + "type": "integer" + }, + { + "description": "the domain ID of the autoscale policy", + "name": "domainid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the action to be executed if all the conditions evaluate to true for the specified duration.", + "name": "action", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the project name of the autoscale policy", + "name": "project", "type": "string" }, { - "description": "the account owning the autoscale policy", - "name": "account", + "description": "the project id autoscale policy", + "name": "projectid", "type": "string" }, { @@ -80965,36 +82667,31 @@ "type": "string" }, { - "description": "the action to be executed if all the conditions evaluate to true for the specified duration.", - "name": "action", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "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": "the list of IDs of the conditions that are being evaluated on every interval", - "name": "conditions", - "type": "list" - }, { - "description": "the project id autoscale policy", - "name": "projectid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "the cool down period for which the policy should not be evaluated after the action has been taken", "name": "quiettime", "type": "integer" }, + {}, { - "description": "the autoscale policy ID", - "name": "id", - "type": "string" + "description": "the list of IDs of the conditions that are being evaluated on every interval", + "name": "conditions", + "type": "list" } ] }, @@ -81013,6 +82710,7 @@ ], "related": "", "response": [ + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", @@ -81029,7 +82727,6 @@ "name": "jobid", "type": "string" }, - {}, { "description": "id of rct", "name": "id", @@ -81051,16 +82748,16 @@ "type": "uuid" }, { - "description": "creates a role with this unique name", + "description": "The type of the role, valid options are: Admin, ResourceAdmin, DomainAdmin, User", "length": 255, - "name": "name", + "name": "type", "required": false, "type": "string" }, { - "description": "The type of the role, valid options are: Admin, ResourceAdmin, DomainAdmin, User", + "description": "creates a role with this unique name", "length": 255, - "name": "type", + "name": "name", "required": false, "type": "string" }, @@ -81081,26 +82778,24 @@ ], "related": "importRole,listRoles", "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 role is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "the type of the role", + "name": "type", + "type": "string" + }, + { + "description": "the description of the role", + "name": "description", + "type": "string" }, { - "description": "the type of the role", - "name": "type", + "description": "the ID of the role", + "name": "id", "type": "string" }, { @@ -81109,15 +82804,17 @@ "type": "string" }, { - "description": "the ID of the role", - "name": "id", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the description of the role", - "name": "description", - "type": "string" - } + "description": "true if role is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + {}, + {} ], "since": "4.9.0" }, @@ -81142,39 +82839,33 @@ "type": "integer" }, { - "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" } ], "related": "addVmwareDc", "response": [ + {}, { "description": "The VMware Datacenter name", "name": "name", "type": "string" }, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The VMware Datacenter ID", + "name": "id", "type": "string" }, - {}, { "description": "The VMware vCenter name/ip", "name": "vcenter", @@ -81186,10 +82877,16 @@ "type": "long" }, { - "description": "The VMware Datacenter ID", - "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" - } + }, + {} ] }, { @@ -81198,11 +82895,11 @@ "name": "listZones", "params": [ { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { "description": "true if you want to retrieve all available Zones. False if you only want to return the Zones from which you have at least one VM. Default is false.", @@ -81211,22 +82908,6 @@ "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" - }, - { - "description": "the ID of the zone", - "length": 255, - "name": "id", - "related": "createZone,listZones,listZones", - "required": false, - "type": "uuid" - }, { "description": "the name of the zone", "length": 255, @@ -81235,11 +82916,12 @@ "type": "string" }, { - "description": "", + "description": "the ID of the domain associated with the zone", "length": 255, - "name": "page", + "name": "domainid", + "related": "listDomainChildren,listDomains", "required": false, - "type": "integer" + "type": "uuid" }, { "description": "the network type of the zone that the virtual machine belongs to", @@ -81248,6 +82930,14 @@ "required": false, "type": "string" }, + { + "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, @@ -81256,11 +82946,11 @@ "type": "boolean" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "pagesize", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { "description": "flag to display the resource image for the zones", @@ -81270,55 +82960,72 @@ "type": "boolean" }, { - "description": "List zones by resource tags (key/value pairs)", + "description": "the ID of the zone", "length": 255, - "name": "tags", + "name": "id", + "related": "createZone,listZones,listZones", "required": false, - "since": "4.3", - "type": "map" + "type": "uuid" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" } ], "related": "createZone,listZones", "response": [ { - "description": "the network type of the zone; can be Basic or Advanced", - "name": "networktype", + "description": "the second internal DNS for the Zone", + "name": "internaldns2", "type": "string" }, { - "description": "the UUID of the containing domain, null for public zones", - "name": "domainid", + "description": "true if security groups support is enabled, false otherwise", + "name": "securitygroupsenabled", + "type": "boolean" + }, + { + "description": "the first DNS for the Zone", + "name": "dns1", "type": "string" }, { - "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 dhcp Provider for the Zone", + "name": "dhcpprovider", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the UUID of the containing domain, null for public zones", + "name": "domainid", + "type": "string" }, { - "description": "true if security groups support is enabled, false otherwise", - "name": "securitygroupsenabled", - "type": "boolean" + "description": "Zone description", + "name": "description", + "type": "string" }, { - "description": "the second internal DNS for the Zone", - "name": "internaldns2", + "description": "the second IPv6 DNS for the Zone", + "name": "ip6dns2", "type": "string" }, { - "description": "the display text of the zone", - "name": "displaytext", + "description": "the guest CIDR address for the Zone", + "name": "guestcidraddress", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "Network domain name for the networks in the zone", + "name": "domain", + "type": "string" }, { "description": "the allocation state of the cluster", @@ -81326,122 +83033,80 @@ "type": "string" }, { - "description": "the list of resource tags associated with zone.", - "name": "tags", + "description": "Zone Token", + "name": "zonetoken", + "type": "string" + }, + { + "description": "the capacity of the Zone", + "name": "capacity", "response": [ { - "description": "id of the resource", - "name": "resourceid", + "description": "the Cluster ID", + "name": "clusterid", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the capacity name", + "name": "name", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the Pod name", + "name": "podname", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the Cluster name", + "name": "clustername", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the Zone name", + "name": "zonename", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the Zone ID", + "name": "zoneid", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the percentage of capacity currently in use", + "name": "percentused", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", - "type": "string" + "description": "the capacity currently in use", + "name": "capacityused", + "type": "long" }, { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" + "description": "the capacity type", + "name": "type", + "type": "short" }, { - "description": "tag value", - "name": "value", + "description": "the Pod ID", + "name": "podid", "type": "string" + }, + { + "description": "the capacity currently in allocated", + "name": "capacityallocated", + "type": "long" + }, + { + "description": "the total capacity available", + "name": "capacitytotal", + "type": "long" } ], - "type": "set" - }, - { - "description": "the first internal DNS for the Zone", - "name": "internaldns1", - "type": "string" - }, - { - "description": "true if local storage offering enabled, false otherwise", - "name": "localstorageenabled", - "type": "boolean" - }, - { - "description": "the second IPv6 DNS for the Zone", - "name": "ip6dns2", - "type": "string" - }, - { - "description": "Zone id", - "name": "id", - "type": "string" - }, - { - "description": "Zone name", - "name": "name", - "type": "string" - }, - { - "description": "the guest CIDR address for the Zone", - "name": "guestcidraddress", - "type": "string" - }, - { - "description": "Network domain name for the networks in the zone", - "name": "domain", - "type": "string" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the first DNS for the Zone", - "name": "dns1", - "type": "string" - }, - { - "description": "Meta data associated with the zone (key/value pairs)", - "name": "resourcedetails", - "type": "map" - }, - { - "description": "Zone description", - "name": "description", - "type": "string" + "type": "list" }, - {}, - {}, { - "description": "the dhcp Provider for the Zone", - "name": "dhcpprovider", + "description": "the first IPv6 DNS for the Zone", + "name": "ip6dns1", "type": "string" }, { @@ -81450,85 +83115,117 @@ "type": "string" }, { - "description": "the first IPv6 DNS for the Zone", - "name": "ip6dns1", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Zone id", + "name": "id", "type": "string" }, { - "description": "the capacity of the Zone", - "name": "capacity", + "description": "the list of resource tags associated with zone.", + "name": "tags", "response": [ { - "description": "the Zone ID", - "name": "zoneid", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the Pod name", - "name": "podname", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the capacity currently in allocated", - "name": "capacityallocated", - "type": "long" - }, - { - "description": "the capacity name", - "name": "name", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the percentage of capacity currently in use", - "name": "percentused", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the capacity currently in use", - "name": "capacityused", - "type": "long" - }, - { - "description": "the Cluster ID", - "name": "clusterid", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the capacity type", - "name": "type", - "type": "short" + "description": "customer associated with the tag", + "name": "customer", + "type": "string" }, { - "description": "the total capacity available", - "name": "capacitytotal", - "type": "long" + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" }, { - "description": "the Cluster name", - "name": "clustername", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the Zone name", - "name": "zonename", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the Pod ID", - "name": "podid", + "description": "resource type", + "name": "resourcetype", "type": "string" } ], - "type": "list" + "type": "set" }, { - "description": "Zone Token", - "name": "zonetoken", + "description": "the display text of the zone", + "name": "displaytext", + "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": "Meta data associated with the zone (key/value pairs)", + "name": "resourcedetails", + "type": "map" + }, + { + "description": "Zone name", + "name": "name", + "type": "string" + }, + {}, + { + "description": "the second DNS for the Zone", + "name": "dns2", + "type": "string" + }, + { + "description": "the network type of the zone; can be Basic or Advanced", + "name": "networktype", + "type": "string" + }, + { + "description": "true if local storage offering enabled, false otherwise", + "name": "localstorageenabled", + "type": "boolean" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + {}, + { + "description": "the first internal DNS for the Zone", + "name": "internaldns1", "type": "string" } ] @@ -81538,22 +83235,6 @@ "isasync": false, "name": "listRemoteAccessVpns", "params": [ - { - "description": "list objects by project", - "length": 255, - "name": "projectid", - "related": "activateProject,suspendProject", - "required": false, - "type": "uuid" - }, - { - "description": "list only resources belonging to the domain specified", - "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", - "required": false, - "type": "uuid" - }, { "description": "", "length": 255, @@ -81562,27 +83243,29 @@ "type": "integer" }, { - "description": "List by keyword", + "description": "Lists remote access vpn rule with the specified ID", "length": 255, - "name": "keyword", + "name": "id", + "related": "listRemoteAccessVpns,updateRemoteAccessVpn", "required": false, - "type": "string" + "since": "4.3", + "type": "uuid" }, { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "description": "list remote access VPNs for ceratin network", "length": 255, - "name": "fordisplay", + "name": "networkid", + "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listBrocadeVcsDeviceNetworks", "required": false, - "since": "4.4", - "type": "boolean" + "since": "4.3", + "type": "uuid" }, { - "description": "public ip address id of the vpn server", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "publicipid", - "related": "updateIpAddress,associateIpAddress,listPublicIpAddresses", + "name": "listall", "required": false, - "type": "uuid" + "type": "boolean" }, { "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", @@ -81592,12 +83275,18 @@ "type": "boolean" }, { - "description": "Lists remote access vpn rule with the specified ID", + "description": "", "length": 255, - "name": "id", - "related": "listRemoteAccessVpns,updateRemoteAccessVpn", + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "description": "list only resources belonging to the domain specified", + "length": 255, + "name": "domainid", + "related": "listDomainChildren,listDomains", "required": false, - "since": "4.3", "type": "uuid" }, { @@ -81608,34 +83297,42 @@ "type": "string" }, { - "description": "list remote access VPNs for ceratin network", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "networkid", - "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork,listF5LoadBalancerNetworks,listNetscalerLoadBalancerNetworks,listBrocadeVcsDeviceNetworks", + "name": "projectid", + "related": "activateProject,suspendProject", "required": false, - "since": "4.3", "type": "uuid" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false", + "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", "length": 255, - "name": "listall", + "name": "fordisplay", "required": false, + "since": "4.4", "type": "boolean" }, { - "description": "", + "description": "public ip address id of the vpn server", "length": 255, - "name": "pagesize", + "name": "publicipid", + "related": "updateIpAddress,associateIpAddress,listPublicIpAddresses", "required": false, - "type": "integer" + "type": "uuid" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" } ], "related": "updateRemoteAccessVpn", "response": [ { - "description": "the range of ips to allocate to the clients", - "name": "iprange", + "description": "the id of the remote access vpn", + "name": "id", "type": "string" }, { @@ -81643,10 +83340,9 @@ "name": "presharedkey", "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the domain id of the account of the remote access vpn", + "name": "domainid", "type": "string" }, { @@ -81655,13 +83351,8 @@ "type": "string" }, { - "description": "the project name of the vpn", - "name": "project", - "type": "string" - }, - { - "description": "the state of the rule", - "name": "state", + "description": "the public ip address of the vpn server", + "name": "publicip", "type": "string" }, { @@ -81670,23 +83361,24 @@ "type": "boolean" }, { - "description": "the account of the remote access vpn", - "name": "account", + "description": "the state of the rule", + "name": "state", "type": "string" }, + {}, { - "description": "the id of the remote access vpn", - "name": "id", + "description": "the project name of the vpn", + "name": "project", "type": "string" }, { - "description": "the public ip address of the vpn server", - "name": "publicip", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the domain id of the account of the remote access vpn", - "name": "domainid", + "description": "the account of the remote access vpn", + "name": "account", "type": "string" }, {}, @@ -81695,6 +83387,11 @@ "name": "domain", "type": "string" }, + { + "description": "the range of ips to allocate to the clients", + "name": "iprange", + "type": "string" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", @@ -81722,69 +83419,29 @@ } ], "response": [ + {}, {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - }, - {}, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - } - ] - }, - { - "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": "true if operation is executed successfully", "name": "success", "type": "boolean" }, - {}, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - {} - ], - "since": "4.14.0" + } + ] }, { "description": "Removes secondary IP from the NIC.", @@ -81801,27 +83458,27 @@ } ], "response": [ + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, - {}, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, + {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" } ] }, @@ -81830,19 +83487,11 @@ "isasync": true, "name": "createServiceInstance", "params": [ - { - "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 left (inside) network for service instance", "length": 255, "name": "leftnetworkid", - "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork,listF5LoadBalancerNetworks,listNetscalerLoadBalancerNetworks,listBrocadeVcsDeviceNetworks", + "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listBrocadeVcsDeviceNetworks", "required": true, "type": "uuid" }, @@ -81855,28 +83504,44 @@ "type": "uuid" }, { - "description": "The name of the service instance", + "description": "The template ID that specifies the image for the service appliance", "length": 255, - "name": "name", + "name": "templateid", + "related": "registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", "required": true, - "type": "string" + "type": "uuid" + }, + { + "description": "Availability zone for the service instance", + "length": 255, + "name": "zoneid", + "related": "createZone,listZones", + "required": true, + "type": "uuid" }, { "description": "The right (outside) network ID for the service instance", "length": 255, "name": "rightnetworkid", - "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork,listF5LoadBalancerNetworks,listNetscalerLoadBalancerNetworks,listBrocadeVcsDeviceNetworks", + "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listBrocadeVcsDeviceNetworks", "required": true, "type": "uuid" }, { - "description": "Availability zone for the service instance", + "description": "The service offering ID that defines the resources consumed by the service appliance", "length": 255, - "name": "zoneid", - "related": "createZone,listZones", + "name": "serviceofferingid", + "related": "updateServiceOffering,listServiceOfferings", "required": true, "type": "uuid" }, + { + "description": "The name of the service instance", + "length": 255, + "name": "name", + "required": true, + "type": "string" + }, { "description": "An optional account for the virtual machine. Must be used with domainId.", "length": 255, @@ -81891,27 +83556,19 @@ "related": "activateProject,suspendProject", "required": false, "type": "uuid" - }, - { - "description": "The template ID that specifies the image for the service appliance", - "length": 255, - "name": "templateid", - "related": "registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", - "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": "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" }, { @@ -81919,26 +83576,11 @@ "name": "project", "type": "string" }, - { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", - "type": "string" - }, { "description": "the project id of the vm", "name": "projectid", "type": "string" }, - { - "description": "the ID of the virtual machine", - "name": "id", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "the ID of the domain in which the virtual machine exists", "name": "domainid", @@ -81949,105 +83591,28 @@ "name": "name", "type": "string" }, - {}, - { - "description": "the account associated with the virtual machine", - "name": "account", - "type": "string" - } - ] - }, - { - "description": "Lists external backup offerings of the provider", - "isasync": false, - "name": "listBackupProviderOfferings", - "params": [ - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - }, - { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, - { - "description": "The zone ID", - "length": 255, - "name": "zoneid", - "related": "createZone,listZones", - "required": true, - "type": "uuid" - }, - { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - } - ], - "related": "importBackupOffering", - "response": [ { - "description": "ID of the backup offering", + "description": "the ID of the virtual machine", "name": "id", "type": "string" }, - { - "description": "zone name", - "name": "zonename", - "type": "string" - }, - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "whether offering allows user driven ad-hoc/scheduled backups", - "name": "allowuserdrivenbackups", - "type": "boolean" - }, - { - "description": "the date this backup offering was created", - "name": "created", - "type": "date" - }, {}, { - "description": "zone ID", - "name": "zoneid", - "type": "string" - }, - { - "description": "name for the backup offering", - "name": "name", + "description": "the account associated with the virtual machine", + "name": "account", "type": "string" }, { - "description": "description for the backup offering", - "name": "description", + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", "type": "string" }, { - "description": "external ID on the provider side", - "name": "externalid", + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", "type": "string" } - ], - "since": "4.14.0" + ] }, { "description": "Releases a Public IP range back to the system pool", @@ -82069,23 +83634,23 @@ "name": "displaytext", "type": "string" }, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - {}, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" - } + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {}, + {} ] }, { @@ -82102,18 +83667,18 @@ "type": "uuid" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "pagesize", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { "description": "", @@ -82123,138 +83688,112 @@ "type": "integer" } ], - "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork,listF5LoadBalancerNetworks,listBrocadeVcsDeviceNetworks", + "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork,listBrocadeVcsDeviceNetworks", "response": [ { - "description": "The external id of the network", - "name": "externalid", + "description": "The vlan of the network. This parameter is visible to ROOT admins only", + "name": "vlan", "type": "string" }, { - "description": "an optional field, whether to the display the network to the end user or not.", - "name": "displaynetwork", - "type": "boolean" + "description": "Name of the VPC to which this network belongs", + "name": "vpcname", + "type": "string" }, { - "description": "the first DNS for the network", - "name": "dns1", + "description": "acl type - access type to the network", + "name": "acltype", "type": "string" }, + {}, { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "the project name of the address", + "name": "project", "type": "string" }, { - "description": "the list of resource tags associated with network", - "name": "tags", - "response": [ - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - } - ], - "type": "list" + "description": "related to what other network configuration", + "name": "related", + "type": "string" }, { - "description": "ACL Id associated with the VPC network", - "name": "aclid", + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" + }, + { + "description": "the date this network was created", + "name": "created", + "type": "date" + }, + { + "description": "ACL name associated with the VPC network", + "name": "aclname", "type": "string" }, { - "description": "list networks that are persistent", - "name": "ispersistent", - "type": "boolean" + "description": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR", + "name": "cidr", + "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 physical network id", + "name": "physicalnetworkid", "type": "string" }, { - "description": "the name of the network", - "name": "name", + "description": "the ID of the Network associated with this network", + "name": "associatednetworkid", "type": "string" }, { - "description": "the date this network was created", - "name": "created", - "type": "date" + "description": "VPC the network belongs to", + "name": "vpcid", + "type": "string" }, { - "description": "true if users from subdomains can access the domain level network", - "name": "subdomainaccess", - "type": "boolean" + "description": "the name of the Network associated with this private gateway", + "name": "associatednetwork", + "type": "string" }, { - "description": "ACL name associated with the VPC network", - "name": "aclname", + "description": "the displaytext of the network", + "name": "displaytext", "type": "string" }, + { + "description": "list networks that are persistent", + "name": "ispersistent", + "type": "boolean" + }, + { + "description": "true if network is system, false otherwise", + "name": "issystem", + "type": "boolean" + }, { "description": "true if network supports specifying ip ranges, false otherwise", "name": "specifyipranges", "type": "boolean" }, { - "description": "the id of the network", - "name": "id", + "description": "the second DNS for the network", + "name": "dns2", "type": "string" }, { - "description": "zone id of the network", - "name": "zoneid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "Name of the VPC to which this network belongs", - "name": "vpcname", + "description": "The routing mode of network offering", + "name": "ip6routing", + "type": "string" + }, + { + "description": "the owner of the network", + "name": "account", "type": "string" }, { @@ -82263,235 +83802,239 @@ "type": "string" }, { - "description": "the network's gateway", - "name": "gateway", + "description": "the domain name of the network owner", + "name": "domain", "type": "string" }, { - "description": "display text of the network offering the network is created from", - "name": "networkofferingdisplaytext", + "description": "the type of the network", + "name": "type", "type": "string" }, { - "description": "If a network is enabled for 'streched l2 subnet' then represents zones on which network currently spans", - "name": "zonesnetworkspans", - "type": "set" + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" }, { - "description": "true if network offering is ip conserve mode enabled", - "name": "networkofferingconservemode", - "type": "boolean" + "description": "the name of the network", + "name": "name", + "type": "string" }, { - "description": "the name of the zone the network belongs to", - "name": "zonename", + "description": "zone id of the network", + "name": "zoneid", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "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": "broadcast uri of the network. This parameter is visible to ROOT admins only", - "name": "broadcasturi", + "description": "the project id of the ipaddress", + "name": "projectid", "type": "string" }, { - "description": "Broadcast domain type of the network", - "name": "broadcastdomaintype", + "description": "name of the network offering the network is created from", + "name": "networkofferingname", "type": "string" }, { - "description": "list networks available for vm deployment", - "name": "canusefordeploy", + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "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": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + } + ], + "type": "list" + }, + { + "description": "true if network offering is ip conserve mode enabled", + "name": "networkofferingconservemode", "type": "boolean" }, { - "description": "network offering id the network is created from", - "name": "networkofferingid", - "type": "string" + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" }, { - "description": "The vlan of the network. This parameter is visible to ROOT admins only", - "name": "vlan", - "type": "string" + "description": "If the network has redundant routers enabled", + "name": "redundantrouter", + "type": "boolean" }, { - "description": "the network domain", - "name": "networkdomain", + "description": "The internet protocol of network offering", + "name": "internetprotocol", "type": "string" }, { - "description": "the second DNS for the network", - "name": "dns2", - "type": "string" + "description": "an optional field, whether to the display the network to the end user or not.", + "name": "displaynetwork", + "type": "boolean" }, { - "description": "the project name of the address", - "name": "project", - "type": "string" + "description": "true if network is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "the owner of the network", - "name": "account", + "description": "the first DNS for the network", + "name": "dns1", "type": "string" }, { - "description": "the type of the network", - "name": "type", + "description": "the network's gateway", + "name": "gateway", "type": "string" }, { - "description": "true if network is system, false otherwise", - "name": "issystem", - "type": "boolean" - }, - { - "description": "the domain id of the network owner", - "name": "domainid", - "type": "string" + "description": "The routes for the network to ease adding route in upstream router", + "name": "ip6routes", + "type": "set" }, { - "description": "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": "If a network is enabled for 'streched l2 subnet' then represents zones on which network currently spans", + "name": "zonesnetworkspans", + "type": "set" }, { - "description": "the displaytext of the network", - "name": "displaytext", + "description": "broadcast uri of the network. This parameter is visible to ROOT admins only", + "name": "broadcasturi", "type": "string" }, { - "description": "If the network has redundant routers enabled", - "name": "redundantrouter", + "description": "list networks available for vm deployment", + "name": "canusefordeploy", "type": "boolean" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "true network requires restart", + "name": "restartrequired", "type": "boolean" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" - }, - { - "description": "acl type - access type to the network", - "name": "acltype", + "description": "the network CIDR of the guest network configured with IP reservation. It is the summation of CIDR and RESERVED_IP_RANGE", + "name": "networkcidr", "type": "string" }, { - "description": "name of the network offering the network is created from", - "name": "networkofferingname", + "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 details of the network", - "name": "details", - "type": "map" + "description": "the id of the network", + "name": "id", + "type": "string" }, { "description": "availability of the network offering the network is created from", "name": "networkofferingavailability", "type": "string" }, - { - "description": "state of the network", - "name": "state", - "type": "string" - }, - { - "description": "the domain name of the network owner", - "name": "domain", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "related to what other network configuration", - "name": "related", - "type": "string" - }, - {}, - { - "description": "the traffic type of the network", - "name": "traffictype", - "type": "string" - }, { "description": "true if network can span multiple zones", "name": "strechedl2subnet", "type": "boolean" }, { - "description": "true if network is default, false otherwise", - "name": "isdefault", + "description": "true if guest network default egress policy is allow; false if default egress policy is deny", + "name": "egressdefaultpolicy", "type": "boolean" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" - }, - { - "description": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR", - "name": "cidr", + "description": "state of the network", + "name": "state", "type": "string" }, { - "description": "the physical network id", - "name": "physicalnetworkid", + "description": "network offering id the network is created from", + "name": "networkofferingid", "type": "string" }, - {}, { - "description": "the network's netmask", - "name": "netmask", + "description": "the traffic type of the network", + "name": "traffictype", "type": "string" }, { "description": "the list of services", "name": "service", "response": [ - { - "description": "the service name", - "name": "name", - "type": "string" - }, - { - "description": "the list of capabilities", - "name": "capability", - "response": [ - { - "description": "the capability value", - "name": "value", - "type": "string" - }, - { - "description": "can this service capability value can be choosable while creatine network offerings", - "name": "canchooseservicecapability", - "type": "boolean" - }, - { - "description": "the capability name", - "name": "name", - "type": "string" - } - ], - "type": "list" - }, { "description": "the service provider name", "name": "provider", "response": [ { - "description": "state of the network provider", - "name": "state", + "description": "the physical network this belongs to", + "name": "physicalnetworkid", "type": "string" }, { @@ -82500,8 +84043,8 @@ "type": "boolean" }, { - "description": "the destination physical network", - "name": "destinationphysicalnetworkid", + "description": "uuid of the network provider", + "name": "id", "type": "string" }, { @@ -82510,19 +84053,46 @@ "type": "list" }, { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", + "description": "the destination physical network", + "name": "destinationphysicalnetworkid", "type": "string" }, { - "description": "uuid of the network provider", - "name": "id", + "description": "the provider name", + "name": "name", "type": "string" }, { - "description": "the provider name", + "description": "state of the network provider", + "name": "state", + "type": "string" + } + ], + "type": "list" + }, + { + "description": "the service name", + "name": "name", + "type": "string" + }, + { + "description": "the list of capabilities", + "name": "capability", + "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" @@ -82531,24 +84101,59 @@ "type": "list" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "ACL Id associated with the VPC network", + "name": "aclid", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the domain id of the network owner", + "name": "domainid", + "type": "string" }, { - "description": "VPC the network belongs to", - "name": "vpcid", + "description": "true if users from subdomains can access the domain level network", + "name": "subdomainaccess", + "type": "boolean" + }, + { + "description": "the network's netmask", + "name": "netmask", "type": "string" }, { - "description": "true network requires restart", - "name": "restartrequired", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" + }, + { + "description": "Broadcast domain type of the network", + "name": "broadcastdomaintype", + "type": "string" + }, + { + "description": "The external id of the network", + "name": "externalid", + "type": "string" + }, + { + "description": "display text of the network offering the network is created from", + "name": "networkofferingdisplaytext", + "type": "string" + }, + { + "description": "the details of the network", + "name": "details", + "type": "map" + }, + { + "description": "the ID of the Network associated with this private gateway", + "name": "associatednetworkid", + "type": "string" + }, + { + "description": "the name of the Network associated with this network", + "name": "associatednetwork", + "type": "string" } ] }, @@ -82569,14 +84174,9 @@ "related": "migrateSystemVm", "response": [ { - "description": "the systemvm agent version", - "name": "version", - "type": "string" - }, - { - "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 link local IP address for the system vm", @@ -82589,85 +84189,101 @@ "type": "string" }, { - "description": "the host ID for the system VM", - "name": "hostid", + "description": "the gateway for the system VM", + "name": "gateway", "type": "string" }, + {}, + {}, { - "description": "the number of active console sessions for the console proxy system vm", - "name": "activeviewersessions", + "description": "the job status associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job.", + "name": "jobstatus", "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the link local MAC address for the system vm", + "name": "linklocalmacaddress", "type": "string" }, { - "description": "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", + "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 agent state of the system VM", + "name": "agentstate", + "type": "string" }, { - "description": "the Zone name for the system VM", - "name": "zonename", + "description": "the ID of the system VM", + "name": "id", "type": "string" }, { - "description": "the state of the system VM", - "name": "state", + "description": "the system VM type", + "name": "systemvmtype", "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 ID for the system VM", - "name": "podid", + "description": "the systemvm agent version", + "name": "version", "type": "string" }, { - "description": "the network domain for the system VM", - "name": "networkdomain", + "description": "the host ID for the system VM", + "name": "hostid", "type": "string" }, { - "description": "the Pod name for the system VM", - "name": "podname", + "description": "the number of active console sessions for the console proxy system vm", + "name": "activeviewersessions", + "type": "integer" + }, + { + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" + }, + { + "description": "the private MAC address for the system VM", + "name": "privatemacaddress", "type": "string" }, { - "description": "the date and time the system VM was created", - "name": "created", - "type": "date" + "description": "the Pod ID for the system VM", + "name": "podid", + "type": "string" }, { - "description": "the system VM type", - "name": "systemvmtype", + "description": "the public netmask for the system VM", + "name": "publicnetmask", "type": "string" }, { - "description": "the job ID associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job.", + "description": "the Zone ID for the system VM", + "name": "zoneid", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - {}, { - "description": "the template ID for the system VM", - "name": "templateid", + "description": "the first DNS for the system VM", + "name": "dns1", "type": "string" }, { - "description": "public vlan range", - "name": "publicvlan", - "type": "list" + "description": "the Pod name for the system VM", + "name": "podname", + "type": "string" }, { "description": "guest vlan range", @@ -82675,8 +84291,8 @@ "type": "string" }, { - "description": "the private IP address for the system VM", - "name": "privateip", + "description": "the network domain for the system VM", + "name": "networkdomain", "type": "string" }, { @@ -82685,99 +84301,208 @@ "type": "string" }, { - "description": "the agent state of the system VM", - "name": "agentstate", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the public netmask for the system VM", - "name": "publicnetmask", + "description": "the Zone name for the system VM", + "name": "zonename", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the link local netmask for the system vm", + "name": "linklocalnetmask", + "type": "string" }, - {}, { - "description": "the second DNS for the system VM", - "name": "dns2", + "description": "the public IP address for the system VM", + "name": "publicip", "type": "string" }, + { + "description": "public vlan range", + "name": "publicvlan", + "type": "list" + }, { "description": "the last disconnected date of host", "name": "disconnected", "type": "date" }, { - "description": "the template name for the system VM", - "name": "templatename", - "type": "string" + "description": "the date and time the system VM was created", + "name": "created", + "type": "date" }, { - "description": "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 system VM", - "name": "id", + "description": "the public MAC address for the system VM", + "name": "publicmacaddress", "type": "string" }, { - "description": "the Zone ID for the system VM", - "name": "zoneid", + "description": "the private IP address for the system VM", + "name": "privateip", "type": "string" }, { - "description": "the name of the system VM", - "name": "name", + "description": "the state of the system VM", + "name": "state", "type": "string" }, { - "description": "the public IP address for the system VM", - "name": "publicip", + "description": "the template ID for the system VM", + "name": "templateid", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the job ID associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job.", + "name": "jobid", "type": "string" }, { - "description": "the public MAC address for the system VM", - "name": "publicmacaddress", + "description": "the second DNS for the system VM", + "name": "dns2", "type": "string" + } + ] + }, + { + "description": "Lists supported methods of network isolation", + "isasync": false, + "name": "listNetworkIsolationMethods", + "params": [ + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "the private MAC address for the system VM", - "name": "privatemacaddress", - "type": "string" + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" }, { - "description": "the first DNS for the system VM", - "name": "dns1", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + } + ], + "related": "", + "response": [ + { + "description": "Network isolation method name", + "name": "name", "type": "string" }, + {}, + {}, { - "description": "the link local MAC address for the system vm", - "name": "linklocalmacaddress", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" } - ] + ], + "since": "4.2.0" + }, + { + "description": "Lists host HA resources", + "isasync": false, + "name": "listHostHAResources", + "params": [ + { + "description": "List by host ID", + "length": 255, + "name": "hostid", + "related": "addBaremetalHost,cancelHostAsDegraded,declareHostAsDegraded,reconnectHost", + "required": false, + "type": "uuid" + } + ], + "related": "configureHAForHost,enableHAForHost,disableHAForHost,listHostHAProviders", + "response": [ + { + "description": "the ID of the host", + "name": "hostid", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the HA state of the host", + "name": "hastate", + "type": "hastate" + }, + { + "description": "the host HA provider", + "name": "haprovider", + "type": "string" + }, + { + "description": "operation status", + "name": "status", + "type": "boolean" + }, + { + "description": "if host HA is enabled for the host", + "name": "haenable", + "type": "boolean" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {}, + {} + ], + "since": "4.11" }, { - "description": "Lists supported methods of network isolation", + "description": "Lists VM stats", "isasync": false, - "name": "listNetworkIsolationMethods", + "name": "listVirtualMachinesUsageHistory", "params": [ { - "description": "", + "description": "end date to filter VM stats.Use format \"yyyy-MM-dd hh:mm:ss\")", "length": 255, - "name": "pagesize", + "name": "enddate", "required": false, - "type": "integer" + "type": "date" + }, + { + "description": "the ID of the virtual machine.", + "length": 255, + "name": "id", + "related": "recoverVirtualMachine,attachIso,destroyVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance", + "required": false, + "type": "uuid" + }, + { + "description": "start date to filter VM stats.Use format \"yyyy-MM-dd hh:mm:ss\")", + "length": 255, + "name": "startdate", + "required": false, + "type": "date" }, { "description": "", @@ -82792,85 +84517,66 @@ "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": "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": "Network isolation method name", + "description": "name of the virtual machine (a substring match is made against the parameter value returning the data for all matching VMs).", + "length": 255, "name": "name", + "required": false, "type": "string" }, - {} - ], - "since": "4.2.0" - }, - { - "description": "Lists host HA resources", - "isasync": false, - "name": "listHostHAResources", - "params": [ { - "description": "List by host ID", + "description": "", "length": 255, - "name": "hostid", - "related": "cancelHostAsDegraded,declareHostAsDegraded,reconnectHost,addBaremetalHost", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" } ], - "related": "configureHAForHost,enableHAForHost,disableHAForHost,listHostHAProviders", + "related": "", "response": [ { - "description": "the ID of the host", - "name": "hostid", - "type": "string" - }, - { - "description": "operation status", - "name": "status", - "type": "boolean" + "description": "the list of VM stats", + "name": "stats", + "type": "list" }, + {}, { - "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 HA state of the host", - "name": "hastate", - "type": "hastate" + "description": "the ID of the virtual machine", + "name": "id", + "type": "string" }, {}, { - "description": "if host HA is enabled for the host", - "name": "haenable", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the host HA provider", - "name": "haprovider", + "description": "the name of the virtual machine", + "name": "name", "type": "string" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" } ], - "since": "4.11" + "since": "4.17" }, { "description": "Declare host as 'Degraded'. Host must be on 'Disconnected' or 'Alert' state. The ADMIN must be sure that there are no VMs running on the respective host otherwise this command might corrupted VMs that were running on the 'Degraded' host.", @@ -82881,119 +84587,147 @@ "description": "host ID", "length": 255, "name": "id", - "related": "cancelHostAsDegraded,declareHostAsDegraded,reconnectHost,addBaremetalHost", + "related": "addBaremetalHost,cancelHostAsDegraded,declareHostAsDegraded,reconnectHost", "required": true, "type": "uuid" } ], - "related": "cancelHostAsDegraded,reconnectHost,addBaremetalHost", + "related": "addBaremetalHost,cancelHostAsDegraded,reconnectHost", "response": [ { - "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise", - "name": "hahost", - "type": "boolean" - }, - { - "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", - "name": "memorytotal", - "type": "long" - }, - { - "description": "events available for the host", - "name": "events", + "description": "the amount of the host's CPU currently used", + "name": "cpuused", "type": "string" }, { - "description": "the date and time the host was last pinged", - "name": "lastpinged", - "type": "date" + "description": "the state of the host", + "name": "state", + "type": "status" }, { - "description": "true if local storage is active, false otherwise", - "name": "islocalstorageactive", - "type": "boolean" + "description": "the host HA information information", + "name": "hostha", + "type": "hostharesponse" }, { - "description": "the amount of the host's CPU currently allocated in MHz", - "name": "cpuallocatedvalue", - "type": "long" + "description": "Host details in key/value pairs.", + "name": "details", + "type": "map" }, { - "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor", - "name": "cpuwithoverprovisioning", + "description": "the OS category name of the host", + "name": "oscategoryname", "type": "string" }, - { - "description": "the outgoing network traffic on the host", - "name": "networkkbswrite", - "type": "long" - }, { "description": "the last annotation set on this host by an admin", "name": "annotation", "type": "string" }, { - "description": "the total disk size of the host", - "name": "disksizetotal", + "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", + "name": "memorytotal", "type": "long" }, + {}, { - "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 X resolution per display", + "name": "maxresolutionx", + "type": "long" + }, + { + "description": "Maximum no. of vgpu per gpu card (pgpu)", + "name": "maxvgpuperpgpu", + "type": "long" + }, + { + "description": "Model Name of vGPU", + "name": "vgputype", + "type": "string" + }, + { + "description": "Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type", + "name": "remainingcapacity", + "type": "long" + }, + { + "description": "Video RAM for this vGPU type", + "name": "videoram", + "type": "long" + }, + { + "description": "Maximum vgpu can be created with this vgpu type on the given gpu group", + "name": "maxcapacity", + "type": "long" + }, + { + "description": "Maximum Y resolution per display", + "name": "maxresolutiony", + "type": "long" + } + ], + "type": "list" + } + ], + "type": "list" }, { - "description": "the cluster type of the cluster that host belongs to", - "name": "clustertype", + "description": "the management server ID of the host", + "name": "managementserverid", "type": "string" }, { - "description": "the cpu average load on the host", - "name": "cpuloadaverage", - "type": "double" - }, - { - "description": "the Zone name of the host", - "name": "zonename", - "type": "string" + "description": "the date and time the host was last pinged", + "name": "lastpinged", + "type": "date" }, { "description": "the date and time the host was created", "name": "created", "type": "date" }, - { - "description": "the admin that annotated this host", - "name": "username", - "type": "string" - }, { "description": "the IP address of the host", "name": "ipaddress", "type": "string" }, { - "description": "the amount of the host's memory currently used", - "name": "memoryused", + "description": "the host's currently allocated disk size", + "name": "disksizeallocated", "type": "long" }, { - "description": "the date and time the host was removed", - "name": "removed", + "description": "true if the host is disconnected. False otherwise.", + "name": "disconnected", "type": "date" }, { - "description": "the resource state of the host", - "name": "resourcestate", - "type": "string" + "description": "the number of CPU sockets on the host", + "name": "cpusockets", + "type": "integer" }, - {}, - {}, { - "description": "true if this host is suitable(has enough capacity and satisfies all conditions like hosttags, max guests vm limit etc) to migrate a VM to it , false otherwise", - "name": "suitableformigration", - "type": "boolean" + "description": "the 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", @@ -83001,93 +84735,113 @@ "type": "boolean" }, { - "description": "the cluster name of the host", - "name": "clustername", - "type": "string" + "description": "true if the host has capability to support UEFI boot", + "name": "ueficapability", + "type": "boolean" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the Zone ID of the host", + "name": "zoneid", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the amount of the host's CPU currently allocated", + "name": "cpuallocated", "type": "string" }, { - "description": "the management server ID of the host", - "name": "managementserverid", + "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor", + "name": "cpuwithoverprovisioning", "type": "string" }, { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", + "description": "the outgoing network traffic on the host", + "name": "networkkbswrite", "type": "long" }, { - "description": "the host version", - "name": "version", + "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", + "name": "cpuallocatedwithoverprovisioning", "type": "string" }, { - "description": "the OS category name of the host", - "name": "oscategoryname", + "description": "the incoming network traffic on the host", + "name": "networkkbsread", + "type": "long" + }, + { + "description": "the admin that annotated this host", + "name": "username", "type": "string" }, { - "description": "the Pod name of the host", - "name": "podname", + "description": "the cluster type of the cluster that host belongs to", + "name": "clustertype", "type": "string" }, { - "description": "the amount of the host's CPU currently used", - "name": "cpuused", + "description": "the name of the host", + "name": "name", "type": "string" }, { - "description": "the incoming network traffic on the host", - "name": "networkkbsread", - "type": "long" + "description": "the cpu average load on the host", + "name": "cpuloadaverage", + "type": "double" }, { - "description": "the OS category ID of the host", - "name": "oscategoryid", + "description": "the date and time the host was removed", + "name": "removed", + "type": "date" + }, + { + "description": "the amount of the host's CPU currently allocated in percentage", + "name": "cpuallocatedpercentage", "type": "string" }, { - "description": "the amount of the host's memory currently allocated in percentage", - "name": "memoryallocatedpercentage", + "description": "the cluster ID of the host", + "name": "clusterid", "type": "string" }, { - "description": "the CPU number of the host", - "name": "cpunumber", - "type": "integer" + "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 amount of the host's memory after applying the mem.overprovisioning.factor", + "name": "memorywithoverprovisioning", + "type": "string" }, { - "description": "comma-separated list of tags for the host", - "name": "hosttags", + "description": "true if local storage is active, false otherwise", + "name": "islocalstorageactive", + "type": "boolean" + }, + { + "description": "the Pod name of the host", + "name": "podname", "type": "string" }, { - "description": "the amount of the host's memory after applying the mem.overprovisioning.factor", - "name": "memorywithoverprovisioning", + "description": "the cluster name of the host", + "name": "clustername", "type": "string" }, { - "description": "the host HA information information", - "name": "hostha", - "type": "hostharesponse" + "description": "the amount of the host's memory currently allocated in percentage", + "name": "memoryallocatedpercentage", + "type": "string" }, { - "description": "the amount of the host's CPU currently allocated in percentage", - "name": "cpuallocatedpercentage", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the host version", + "name": "version", "type": "string" }, { @@ -83096,88 +84850,50 @@ "type": "date" }, { - "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", - "name": "cpuallocatedwithoverprovisioning", + "description": "the amount of the host's CPU currently allocated in MHz", + "name": "cpuallocatedvalue", + "type": "long" + }, + { + "description": "the ID of the host", + "name": "id", "type": "string" }, { - "description": "the number of CPU sockets on the host", - "name": "cpusockets", - "type": "integer" + "description": "the Zone name of the host", + "name": "zonename", + "type": "string" }, { - "description": "GPU cards present in the host", - "name": "gpugroup", - "response": [ - { - "description": "GPU cards present in the host", - "name": "gpugroupname", - "type": "string" - }, - { - "description": "the list of enabled vGPUs", - "name": "vgpu", - "response": [ - { - "description": "Model Name of vGPU", - "name": "vgputype", - "type": "string" - }, - { - "description": "Maximum vgpu can be created with this vgpu type on the given gpu group", - "name": "maxcapacity", - "type": "long" - }, - { - "description": "Maximum displays per user", - "name": "maxheads", - "type": "long" - }, - { - "description": "Video RAM for this vGPU type", - "name": "videoram", - "type": "long" - }, - { - "description": "Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type", - "name": "remainingcapacity", - "type": "long" - }, - { - "description": "Maximum X resolution per display", - "name": "maxresolutionx", - "type": "long" - }, - { - "description": "Maximum Y resolution per display", - "name": "maxresolutiony", - "type": "long" - }, - { - "description": "Maximum no. of vgpu per gpu card (pgpu)", - "name": "maxvgpuperpgpu", - "type": "long" - } - ], - "type": "list" - } - ], - "type": "list" + "description": "events available for the host", + "name": "events", + "type": "string" }, { - "description": "true if the host has capability to support UEFI boot", - "name": "ueficapability", + "description": "comma-separated list of tags for the host", + "name": "hosttags", + "type": "string" + }, + {}, + { + "description": "true if this host is suitable(has enough capacity and satisfies all conditions like hosttags, max guests vm limit etc) to migrate a VM to it , false otherwise", + "name": "suitableformigration", "type": "boolean" }, { - "description": "the cluster ID of the host", - "name": "clusterid", - "type": "string" + "description": "the amount of the host's memory currently used", + "name": "memoryused", + "type": "long" }, { - "description": "the state of the host", - "name": "state", - "type": "status" + "description": "the host type", + "name": "type", + "type": "type" + }, + { + "description": "the host out-of-band management information", + "name": "outofbandmanagement", + "type": "outofbandmanagementresponse" }, { "description": "the host hypervisor", @@ -83185,23 +84901,28 @@ "type": "hypervisortype" }, { - "description": "the ID of the host", - "name": "id", + "description": "the hypervisor version", + "name": "hypervisorversion", "type": "string" }, { - "description": "the name of the host", - "name": "name", + "description": "capabilities of the host", + "name": "capabilities", "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 hypervisor version", - "name": "hypervisorversion", + "description": "the resource state of the host", + "name": "resourcestate", + "type": "string" + }, + { + "description": "the OS category ID of the host", + "name": "oscategoryid", "type": "string" }, { @@ -83215,39 +84936,24 @@ "type": "long" }, { - "description": "the amount of the host's CPU currently allocated", - "name": "cpuallocated", - "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": "capabilities of the host", - "name": "capabilities", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise", + "name": "hahost", "type": "boolean" }, { - "description": "the host out-of-band management information", - "name": "outofbandmanagement", - "type": "outofbandmanagementresponse" - }, - { - "description": "the Pod ID of the host", - "name": "podid", - "type": "string" - }, - { - "description": "the Zone ID of the host", - "name": "zoneid", - "type": "string" + "description": "the total disk size of the host", + "name": "disksizetotal", + "type": "long" } ], "since": "4.16.0.0" @@ -83258,42 +84964,62 @@ "name": "createKubernetesCluster", "params": [ { - "description": "an optional domainId for the virtual machine. If the account parameter is used, domainId must also be used.", + "description": "root disk size in GB for each node", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", + "name": "noderootdisksize", + "required": false, + "type": "long" + }, + { + "description": "external load balancer IP address while using shared network with Kubernetes HA cluster", + "length": 255, + "name": "externalloadbalanceripaddress", "required": false, + "type": "string" + }, + { + "description": "number of Kubernetes cluster worker nodes", + "length": 255, + "name": "size", + "required": true, + "type": "long" + }, + { + "description": "Kubernetes version with which cluster to be launched", + "length": 255, + "name": "kubernetesversionid", + "related": "listKubernetesSupportedVersions", + "required": true, "type": "uuid" }, { - "description": "Network in which Kubernetes cluster is to be launched", + "description": "an optional domainId for the virtual machine. If the account parameter is used, domainId must also be used.", "length": 255, - "name": "networkid", - "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork,listF5LoadBalancerNetworks,listBrocadeVcsDeviceNetworks", + "name": "domainid", + "related": "listDomainChildren,listDomains", "required": false, "type": "uuid" }, { - "description": "name of the ssh key pair used to login to the virtual machines", + "description": "password for the docker image private registry", "length": 255, - "name": "keypair", + "name": "dockerregistrypassword", "required": false, "type": "string" }, { - "description": "number of Kubernetes cluster control nodes, default is 1", + "description": "name of the ssh key pair used to login to the virtual machines", "length": 255, - "name": "controlnodes", + "name": "keypair", "required": false, - "type": "long" + "type": "string" }, { - "description": "Deploy cluster for the project", + "description": "name for the Kubernetes cluster", "length": 255, - "name": "projectid", - "related": "activateProject,suspendProject", - "required": false, - "type": "uuid" + "name": "name", + "required": true, + "type": "string" }, { "description": "description for the Kubernetes cluster", @@ -83303,26 +85029,26 @@ "type": "string" }, { - "description": "root disk size in GB for each node", + "description": "URL for the docker image private registry", "length": 255, - "name": "noderootdisksize", + "name": "dockerregistryurl", "required": false, - "type": "long" + "type": "string" }, { - "description": "Kubernetes version with which cluster to be launched", + "description": "Deploy cluster for the project", "length": 255, - "name": "kubernetesversionid", - "related": "listKubernetesSupportedVersions", - "required": true, + "name": "projectid", + "related": "activateProject,suspendProject", + "required": false, "type": "uuid" }, { - "description": "an optional account for the virtual machine. Must be used with domainId.", + "description": "number of Kubernetes cluster control nodes, default is 1", "length": 255, - "name": "account", + "name": "controlnodes", "required": false, - "type": "string" + "type": "long" }, { "description": "user name for the docker image private registry", @@ -83339,53 +85065,33 @@ "type": "long" }, { - "description": "external load balancer IP address while using shared network with Kubernetes HA cluster", - "length": 255, - "name": "externalloadbalanceripaddress", - "required": false, - "type": "string" - }, - { - "description": "availability zone in which Kubernetes cluster to be launched", + "description": "the ID of the service offering for the virtual machines in the cluster.", "length": 255, - "name": "zoneid", - "related": "createZone,listZones", + "name": "serviceofferingid", + "related": "updateServiceOffering,listServiceOfferings", "required": true, "type": "uuid" }, { - "description": "URL for the docker image private registry", + "description": "Network in which Kubernetes cluster is to be launched", "length": 255, - "name": "dockerregistryurl", + "name": "networkid", + "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork,listBrocadeVcsDeviceNetworks", "required": false, - "type": "string" - }, - { - "description": "name for the Kubernetes cluster", - "length": 255, - "name": "name", - "required": true, - "type": "string" - }, - { - "description": "the ID of the service offering for the virtual machines in the cluster.", - "length": 255, - "name": "serviceofferingid", - "related": "updateServiceOffering,listServiceOfferings", - "required": true, "type": "uuid" }, { - "description": "number of Kubernetes cluster worker nodes", + "description": "availability zone in which Kubernetes cluster to be launched", "length": 255, - "name": "size", + "name": "zoneid", + "related": "createZone,listZones", "required": true, - "type": "long" + "type": "uuid" }, { - "description": "password for the docker image private registry", + "description": "an optional account for the virtual machine. Must be used with domainId.", "length": 255, - "name": "dockerregistrypassword", + "name": "account", "required": false, "type": "string" } @@ -83393,60 +85099,49 @@ "related": "startKubernetesCluster", "response": [ { - "description": "the name of the Kubernetes version for the Kubernetes cluster", - "name": "kubernetesversionname", + "description": "the name of the network of the Kubernetes cluster", + "name": "associatednetworkname", "type": "string" }, { - "description": "the name of the service offering of the Kubernetes cluster", - "name": "serviceofferingname", + "description": "the cpu cores of the Kubernetes cluster", + "name": "cpunumber", "type": "string" }, { - "description": "Public IP Address of the cluster", - "name": "ipaddress", + "description": "the state of the Kubernetes cluster", + "name": "state", "type": "string" }, { - "description": "the list of virtualmachine associated with this Kubernetes cluster", - "name": "virtualmachines", - "type": "list" - }, - { - "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 ID of the template of the Kubernetes cluster", + "name": "templateid", + "type": "string" }, { - "description": "Minimum size of the cluster", - "name": "minsize", - "type": "long" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, - {}, { - "description": "the name of the zone of the Kubernetes cluster", - "name": "zonename", + "description": "the account associated with the Kubernetes cluster", + "name": "account", "type": "string" }, { - "description": "the name of the network of the Kubernetes cluster", - "name": "associatednetworkname", + "description": "the ID of the service offering of the Kubernetes cluster", + "name": "serviceofferingid", "type": "string" }, { - "description": "the ID of the Kubernetes version for the Kubernetes cluster", - "name": "kubernetesversionid", - "type": "string" + "description": "the 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": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { "description": "the project id of the Kubernetes cluster", @@ -83454,120 +85149,136 @@ "type": "string" }, { - "description": "the ID of the service offering of the Kubernetes cluster", - "name": "serviceofferingid", + "description": "keypair details", + "name": "keypair", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "Minimum size of the cluster", + "name": "minsize", + "type": "long" }, { - "description": "keypair details", - "name": "keypair", - "type": "string" + "description": "the master nodes count for the Kubernetes cluster. This parameter is deprecated, please use 'controlnodes' parameter.", + "name": "masternodes", + "type": "long" }, { - "description": "the ID of the network of the Kubernetes cluster", - "name": "networkid", + "description": "URL end point for the Kubernetes cluster dashboard UI", + "name": "consoleendpoint", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the ID of the domain in which the Kubernetes cluster exists", + "name": "domainid", + "type": "string" }, { - "description": "Whether autoscaling is enabled for the cluster", - "name": "autoscalingenabled", - "type": "boolean" + "description": "the description of the Kubernetes cluster", + "name": "description", + "type": "string" }, { - "description": "the name of the Kubernetes cluster", - "name": "name", + "description": "the name of the domain in which the Kubernetes cluster exists", + "name": "domain", "type": "string" }, { - "description": "the project name of the Kubernetes cluster", - "name": "project", + "description": "URL end point for the Kubernetes cluster", + "name": "endpoint", "type": "string" }, { - "description": "the memory the Kubernetes cluster", - "name": "memory", + "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 ID of the Kubernetes version for the Kubernetes cluster", + "name": "kubernetesversionid", "type": "string" }, { - "description": "the ID of the domain in which the Kubernetes cluster exists", - "name": "domainid", + "description": "the ID of the network of the Kubernetes cluster", + "name": "networkid", "type": "string" }, { - "description": "URL end point for the Kubernetes cluster", - "name": "endpoint", + "description": "the name of the zone of the Kubernetes cluster", + "name": "zoneid", "type": "string" }, { - "description": "the master nodes count for the Kubernetes cluster. This parameter is deprecated, please use 'controlnodes' parameter.", - "name": "masternodes", + "description": "Maximum size of the cluster", + "name": "maxsize", "type": "long" }, { - "description": "the cpu cores of the Kubernetes cluster", - "name": "cpunumber", + "description": "the name of the service offering of the Kubernetes cluster", + "name": "serviceofferingname", "type": "string" }, { - "description": "the state of the Kubernetes cluster", - "name": "state", - "type": "string" + "description": "the size (worker nodes count) of the Kubernetes cluster", + "name": "size", + "type": "long" }, { - "description": "the account associated with the Kubernetes cluster", - "name": "account", + "description": "Public IP Address ID of the cluster", + "name": "ipaddressid", "type": "string" }, + {}, { - "description": "the ID of the template of the Kubernetes cluster", - "name": "templateid", + "description": "the name of the Kubernetes cluster", + "name": "name", "type": "string" }, { - "description": "the description of the Kubernetes cluster", - "name": "description", + "description": "the control nodes count for the Kubernetes cluster", + "name": "controlnodes", + "type": "long" + }, + { + "description": "the list of virtualmachine associated with this Kubernetes cluster", + "name": "virtualmachines", + "type": "list" + }, + { + "description": "the project name of the Kubernetes cluster", + "name": "project", "type": "string" }, { - "description": "the id of the Kubernetes cluster", - "name": "id", + "description": "Public IP Address of the cluster", + "name": "ipaddress", "type": "string" }, {}, { - "description": "URL end point for the Kubernetes cluster dashboard UI", - "name": "consoleendpoint", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the name of the zone of the Kubernetes cluster", - "name": "zoneid", + "description": "the name of the Kubernetes version for the Kubernetes cluster", + "name": "kubernetesversionname", "type": "string" }, { - "description": "Public IP Address ID of the cluster", - "name": "ipaddressid", + "description": "the memory the Kubernetes cluster", + "name": "memory", "type": "string" }, { - "description": "Maximum size of the cluster", - "name": "maxsize", - "type": "long" + "description": "Whether autoscaling is enabled for the cluster", + "name": "autoscalingenabled", + "type": "boolean" + }, + { + "description": "the id of the Kubernetes cluster", + "name": "id", + "type": "string" } ] }, @@ -83577,20 +85288,13 @@ "name": "listStorageNetworkIpRange", "params": [ { - "description": "optional parameter. Pod uuid, if specicied and range uuid is absent, using it to search the range.", + "description": "optional parameter. Zone uuid, if specicied and both pod uuid and range uuid are absent, using it to search the range.", "length": 255, - "name": "podid", - "related": "updatePod,createManagementNetworkIpRange", + "name": "zoneid", + "related": "createZone,listZones", "required": false, "type": "uuid" }, - { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, { "description": "", "length": 255, @@ -83606,18 +85310,25 @@ "type": "string" }, { - "description": "optional parameter. Zone uuid, if specicied and both pod uuid and range uuid are absent, using it to search the range.", + "description": "optional parameter. Storaget network IP range uuid, if specicied, using it to search the range.", "length": 255, - "name": "zoneid", - "related": "createZone,listZones", + "name": "id", + "related": "createStorageNetworkIpRange,listStorageNetworkIpRange", "required": false, "type": "uuid" }, { - "description": "optional parameter. Storaget network IP range uuid, if specicied, using it to search the range.", + "description": "", "length": 255, - "name": "id", - "related": "createStorageNetworkIpRange,listStorageNetworkIpRange", + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "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" } @@ -83630,8 +85341,13 @@ "type": "integer" }, { - "description": "the Zone uuid of the storage network IP range", - "name": "zoneid", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the gateway of the storage network IP range", + "name": "gateway", "type": "string" }, { @@ -83640,8 +85356,8 @@ "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the start ip of the storage network IP range", + "name": "startip", "type": "string" }, { @@ -83649,93 +85365,67 @@ "name": "endip", "type": "string" }, - {}, - {}, { - "description": "the gateway of the storage network IP range", - "name": "gateway", + "description": "the netmask of the storage network IP range", + "name": "netmask", "type": "string" }, { - "description": "the uuid of storage network IP range.", - "name": "id", + "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 Pod uuid for the storage network IP range", - "name": "podid", + "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", + "description": "the uuid of storage network IP range.", + "name": "id", "type": "string" }, + {}, { - "description": "the start ip of the storage network IP range", - "name": "startip", + "description": "the Pod uuid for the storage network IP range", + "name": "podid", "type": "string" - } + }, + {} ], "since": "3.0.0" }, { - "description": "Imports a backup offering using a backup provider", + "description": "Deletes a specified domain", "isasync": true, - "name": "importBackupOffering", + "name": "deleteDomain", "params": [ { - "description": "Whether users are allowed to create adhoc backups and backup schedules", - "length": 255, - "name": "allowuserdrivenbackups", - "required": true, - "type": "boolean" - }, - { - "description": "The backup offering ID (from backup provider side)", - "length": 255, - "name": "externalid", - "required": true, - "type": "string" - }, - { - "description": "the description of the backup offering", - "length": 255, - "name": "description", - "required": true, - "type": "string" - }, - { - "description": "The zone ID", + "description": "ID of domain to delete", "length": 255, - "name": "zoneid", - "related": "createZone,listZones", + "name": "id", + "related": "listDomainChildren,listDomains", "required": true, "type": "uuid" }, { - "description": "the name of the backup offering", + "description": "true if all domain resources (child domains, accounts) have to be cleaned up, false otherwise", "length": 255, - "name": "name", - "required": true, - "type": "string" + "name": "cleanup", + "required": false, + "type": "boolean" } ], - "related": "", "response": [ { - "description": "zone name", - "name": "zonename", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, { - "description": "description for the backup offering", - "name": "description", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, { @@ -83743,45 +85433,13 @@ "name": "jobid", "type": "string" }, - {}, - { - "description": "name for the backup offering", - "name": "name", - "type": "string" - }, - { - "description": "external ID on the provider side", - "name": "externalid", - "type": "string" - }, { - "description": "the date this backup offering was created", - "name": "created", - "type": "date" - }, - { - "description": "ID of the backup offering", - "name": "id", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "zone ID", - "name": "zoneid", - "type": "string" - }, - {}, - { - "description": "whether offering allows user driven ad-hoc/scheduled backups", - "name": "allowuserdrivenbackups", + "description": "true if operation is executed successfully", + "name": "success", "type": "boolean" - } - ], - "since": "4.14.0" + }, + {} + ] }, { "description": "Configures a virtual router element.", @@ -83804,104 +85462,58 @@ "type": "uuid" } ], - "related": "listVirtualRouterElements", - "response": [ - { - "description": "the physical network service provider id of the provider", - "name": "nspid", - "type": "string" - }, - { - "description": "the domain ID associated with the provider", - "name": "domainid", - "type": "string" - }, - { - "description": "the project id of the ipaddress", - "name": "projectid", - "type": "string" - }, - { - "description": "the domain associated with the provider", - "name": "domain", - "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": "Enabled/Disabled the service provider", - "name": "enabled", - "type": "boolean" - }, - { - "description": "the id of the router", - "name": "id", - "type": "string" - }, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the project name of the address", - "name": "project", - "type": "string" - } - ] - }, - { - "description": "Deletes a specified domain", - "isasync": true, - "name": "deleteDomain", - "params": [ - { - "description": "ID of domain to delete", - "length": 255, - "name": "id", - "related": "listDomainChildren,listDomains", - "required": true, - "type": "uuid" - }, - { - "description": "true if all domain resources (child domains, accounts) have to be cleaned up, false otherwise", - "length": 255, - "name": "cleanup", - "required": false, - "type": "boolean" - } - ], + "related": "listVirtualRouterElements", "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 domain ID associated with the provider", + "name": "domainid", + "type": "string" + }, + { + "description": "the project id of the ipaddress", + "name": "projectid", + "type": "string" + }, + { + "description": "the domain associated with the provider", + "name": "domain", + "type": "string" + }, + { + "description": "the account associated with the provider", + "name": "account", + "type": "string" + }, + { + "description": "the project name of the address", + "name": "project", + "type": "string" + }, + { + "description": "the id of the router", + "name": "id", + "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": "Enabled/Disabled the service provider", + "name": "enabled", + "type": "boolean" + }, + {}, + { + "description": "the physical network service provider id of the provider", + "name": "nspid", "type": "string" } ] @@ -83915,30 +85527,33 @@ "description": "ID of the host", "length": 255, "name": "hostid", - "related": "cancelHostAsDegraded,reconnectHost,addBaremetalHost", + "related": "addBaremetalHost,cancelHostAsDegraded,reconnectHost", "required": true, "type": "uuid" } ], "related": "configureHAForHost,disableHAForHost,listHostHAProviders", "response": [ - { - "description": "the HA state of the host", - "name": "hastate", - "type": "hastate" - }, { "description": "if host HA is enabled for the host", "name": "haenable", "type": "boolean" }, - {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the HA state of the host", + "name": "hastate", + "type": "hastate" + }, { "description": "operation status", "name": "status", "type": "boolean" }, - {}, { "description": "the ID of the host", "name": "hostid", @@ -83949,16 +85564,13 @@ "name": "haprovider", "type": "string" }, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - } + {} ], "since": "4.11" }, @@ -83971,15 +85583,8 @@ "description": "The new disk offering ID that replaces the current one used by the volume. This new disk offering is used to better reflect the new storage where the volume is going to be migrated to.", "length": 255, "name": "newdiskofferingid", + "related": "", "required": false, - "type": "string" - }, - { - "description": "destination storage pool ID to migrate the volume to", - "length": 255, - "name": "storageid", - "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool", - "required": true, "type": "uuid" }, { @@ -83996,135 +85601,158 @@ "name": "livemigrate", "required": false, "type": "boolean" + }, + { + "description": "destination storage pool ID to migrate the volume to", + "length": 255, + "name": "storageid", + "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool", + "required": true, + "type": "uuid" } ], "related": "createVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", "response": [ - { - "description": "provisioning type used to create volumes.", - "name": "provisioningtype", - "type": "string" - }, { "description": "the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached.", "name": "deviceid", "type": "long" }, { - "description": "type of the disk volume (ROOT or DATADISK)", - "name": "type", + "description": "volume uuid that is given by virtualisation provider (only for VMware)", + "name": "externaluuid", "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the state of the disk volume", + "name": "state", "type": "string" }, { - "description": "cluster name where the volume is allocated", - "name": "clustername", + "description": "the account associated with the disk volume", + "name": "account", + "type": "string" + }, + { + "description": "Hypervisor the volume belongs to", + "name": "hypervisor", "type": "string" }, + { + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" + }, { "description": "the status of the volume", "name": "status", "type": "string" }, { - "description": "cluster id of the volume", - "name": "clusterid", + "description": "name of the primary storage hosting the disk volume", + "name": "storage", "type": "string" }, { - "description": "name of the disk offering", - "name": "diskofferingname", + "description": "shared or local storage", + "name": "storagetype", "type": "string" }, + { + "description": "the chain info of the volume", + "name": "chaininfo", + "type": "string" + }, + { + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" + }, { "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", "name": "templateid", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the bytes actually consumed on disk", + "name": "virtualsize", + "type": "long" }, { - "description": "state of the virtual machine", - "name": "vmstate", + "description": "ID of the snapshot from which this volume was created", + "name": "snapshotid", "type": "string" }, { - "description": "name of the virtual machine", - "name": "vmname", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { - "description": "need quiesce vm or not when taking snapshot", - "name": "quiescevm", - "type": "boolean" + "description": "the date the disk volume was created", + "name": "created", + "type": "date" }, { - "description": "bytes read rate of the disk volume", - "name": "diskBytesReadRate", - "type": "long" + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", + "type": "string" }, { - "description": "the write (bytes) of disk on the vm", - "name": "diskkbswrite", + "description": "IO requests read rate of the disk volume per the disk offering", + "name": "diskIopsReadRate", "type": "long" }, { - "description": "the date the volume was attached to a VM instance", - "name": "attached", - "type": "date" + "description": "the display text of the disk offering", + "name": "diskofferingdisplaytext", + "type": "string" }, { - "description": "the read (io) of disk on the vm", + "description": "the read (IO) of disk on the vm", "name": "diskioread", "type": "long" }, { - "description": "the project name of the vpn", - "name": "project", - "type": "string" + "description": "the date the volume was attached to a VM instance", + "name": "attached", + "type": "date" }, { - "description": "Hypervisor the volume belongs to", - "name": "hypervisor", - "type": "string" + "description": "true if the volume is extractable, false otherwise", + "name": "isextractable", + "type": "boolean" }, { - "description": "name of the service offering for root disk", - "name": "serviceofferingname", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the state of the disk volume", - "name": "state", + "description": "provisioning type used to create volumes.", + "name": "provisioningtype", "type": "string" }, { - "description": "display name of the virtual machine", - "name": "vmdisplayname", + "description": "pod name of the volume", + "name": "podname", "type": "string" }, + {}, { - "description": "the bytes actually consumed on disk", - "name": "virtualsize", - "type": "long" + "description": "id of the virtual machine", + "name": "virtualmachineid", + "type": "string" }, { - "description": "io requests read rate of the disk volume per the disk offering", - "name": "diskIopsReadRate", - "type": "long" + "description": "the boolean state of whether the volume is destroyed or not", + "name": "destroyed", + "type": "boolean" }, { - "description": "the write (io) of disk on the vm", - "name": "diskiowrite", - "type": "long" + "description": "need quiesce vm or not when taking snapshot", + "name": "quiescevm", + "type": "boolean" }, { "description": "the project id of the vpn", @@ -84132,135 +85760,83 @@ "type": "string" }, { - "description": "true if storage snapshot is supported for the volume, false otherwise", - "name": "supportsstoragesnapshot", - "type": "boolean" + "description": "min iops of the disk volume", + "name": "miniops", + "type": "long" }, { - "description": "true if the volume is extractable, false otherwise", - "name": "isextractable", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "id of the virtual machine", - "name": "virtualmachineid", + "description": "name of the disk offering", + "name": "diskofferingname", "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": "id", + "type": "string" }, { - "description": "the date the disk volume was created", - "name": "created", - "type": "date" + "description": "cluster id of the volume", + "name": "clusterid", + "type": "string" }, { - "description": "name of the availability zone", - "name": "zonename", + "description": "pod id of the volume", + "name": "podid", "type": "string" }, { - "description": "the list of resource tags associated", - "name": "tags", - "response": [ - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - } - ], - "type": "set" + "description": "max iops of the disk volume", + "name": "maxiops", + "type": "long" }, { - "description": "the read (bytes) of disk on the vm", - "name": "diskkbsread", + "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 bytes allocated", + "name": "physicalsize", + "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", + "type": "string" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "cluster name where the volume is allocated", + "name": "clustername", "type": "string" }, { - "description": "the domain associated with the disk volume", - "name": "domain", + "description": "the ID of the domain associated with the disk volume", + "name": "domainid", "type": "string" }, { - "description": "min iops of the disk volume", - "name": "miniops", - "type": "long" + "description": "an optional field whether to the display the volume to the end user or not.", + "name": "displayvolume", + "type": "boolean" }, { - "description": "max iops of the disk volume", - "name": "maxiops", - "type": "long" + "description": "the name of the template for the virtual machine", + "name": "templatename", + "type": "string" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "ID of the service offering for root disk", + "name": "serviceofferingid", "type": "string" }, { - "description": "shared or local storage", - "name": "storagetype", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { @@ -84269,29 +85845,18 @@ "type": "string" }, { - "description": "size of the disk volume", - "name": "size", - "type": "long" - }, - { - "description": "name of the disk volume", - "name": "name", - "type": "string" - }, - { - "description": "name of the primary storage hosting the disk volume", - "name": "storage", - "type": "string" + "description": "true if storage snapshot is supported for the volume, false otherwise", + "name": "supportsstoragesnapshot", + "type": "boolean" }, { - "description": "ID of the snapshot from which this volume was created", - "name": "snapshotid", + "description": "ID of the availability zone", + "name": "zoneid", "type": "string" }, - {}, { - "description": "the display text of the service offering for root disk", - "name": "serviceofferingdisplaytext", + "description": "name of the virtual machine", + "name": "vmname", "type": "string" }, { @@ -84300,23 +85865,23 @@ "type": "long" }, { - "description": "ID of the service offering for root disk", - "name": "serviceofferingid", + "description": "name of the service offering for root disk", + "name": "serviceofferingname", "type": "string" }, { - "description": "the chain info of the volume", - "name": "chaininfo", + "description": "display name of the virtual machine", + "name": "vmdisplayname", "type": "string" }, { - "description": "ID of the availability zone", - "name": "zoneid", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "description": "the disk utilization", - "name": "utilization", + "description": "name of the disk volume", + "name": "name", "type": "string" }, { @@ -84325,64 +85890,117 @@ "type": "string" }, { - "description": "pod id of the volume", - "name": "podid", + "description": "bytes read rate of the disk volume", + "name": "diskBytesReadRate", + "type": "long" + }, + { + "description": "the domain associated with the disk volume", + "name": "domain", "type": "string" }, { - "description": "the account associated with the disk volume", - "name": "account", + "description": "name of the availability zone", + "name": "zonename", "type": "string" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "the disk utilization", + "name": "utilization", "type": "string" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "state of the virtual machine", + "name": "vmstate", "type": "string" }, { - "description": "the display text of the disk offering", - "name": "diskofferingdisplaytext", + "description": "type of the disk volume (ROOT or DATADISK)", + "name": "type", "type": "string" }, { - "description": "ID of the disk volume", - "name": "id", + "description": "the project name of the vpn", + "name": "project", "type": "string" }, + {}, { - "description": "the ID of the domain associated with the disk volume", - "name": "domainid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "io requests write rate of the disk volume per the disk offering", + "description": "IO requests write rate of the disk volume per the disk offering", "name": "diskIopsWriteRate", "type": "long" }, { - "description": "the bytes allocated", - "name": "physicalsize", + "description": "size of the disk volume", + "name": "size", "type": "long" }, { - "description": "the path of the volume", - "name": "path", - "type": "string" - }, - { - "description": "pod name of the volume", - "name": "podname", + "description": "the display text of the service offering for root disk", + "name": "serviceofferingdisplaytext", "type": "string" - }, - { - "description": "an optional field whether to the display the volume to the end user or not.", - "name": "displayvolume", - "type": "boolean" } ], "since": "3.0.0" @@ -84393,26 +86011,41 @@ "name": "listEvents", "params": [ { - "description": "List by keyword", + "description": "the ID of the resource associated with the event", "length": 255, - "name": "keyword", + "name": "resourceid", + "required": false, + "since": "4.17.0", + "type": "string" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "description": "the duration of the event", + "length": 255, + "name": "duration", "required": false, - "type": "string" + "type": "integer" }, { - "description": "the parent/start ID of the event, when provided this will list all the events with the start/parent ID including the parent event", + "description": "the ID of the event", "length": 255, - "name": "startid", + "name": "id", "related": "listEvents", "required": false, "type": "uuid" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "the time the event was entered", "length": 255, - "name": "account", + "name": "entrytime", "required": false, - "type": "string" + "type": "integer" }, { "description": "the event level (INFO, WARN, ERROR)", @@ -84422,43 +86055,44 @@ "type": "string" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "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": "isrecursive", + "name": "startid", + "related": "listEvents", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "list only resources belonging to the domain specified", + "description": "the start date range of the list you want to retrieve (use format \"yyyy-MM-dd\" or the new format \"yyyy-MM-dd HH:mm:ss\")", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", + "name": "startdate", "required": false, - "type": "uuid" + "type": "date" }, { - "description": "", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "page", + "name": "isrecursive", "required": false, - "type": "integer" + "type": "boolean" }, { - "description": "the time the event was entered", + "description": "", "length": 255, - "name": "entrytime", + "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", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "listall", + "name": "domainid", + "related": "listDomainChildren,listDomains", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "list objects by project", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, "name": "projectid", "related": "activateProject,suspendProject", @@ -84466,11 +86100,11 @@ "type": "uuid" }, { - "description": "the event type (see event types)", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller 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": "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\")", @@ -84480,52 +86114,50 @@ "type": "date" }, { - "description": "the ID of the event", + "description": "List by keyword", "length": 255, - "name": "id", - "related": "listEvents", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "the duration of the event", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "duration", + "name": "account", "required": false, - "type": "integer" + "type": "string" }, { - "description": "the start date range of the list you want to retrieve (use format \"yyyy-MM-dd\" or the new format \"yyyy-MM-dd HH:mm:ss\")", + "description": "the type of the resource associated with the event", "length": 255, - "name": "startdate", + "name": "resourcetype", "required": false, - "type": "date" + "since": "4.17.0", + "type": "string" }, { - "description": "", + "description": "the event type (see event types)", "length": 255, - "name": "pagesize", + "name": "type", "required": false, - "type": "integer" + "type": "string" } ], "related": "", "response": [ { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the type of the resource", + "name": "resourcetype", + "type": "string" }, - {}, { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "a brief description of the event", + "name": "description", "type": "string" }, - {}, { - "description": "the id of the account's domain", - "name": "domainid", + "description": "the id of the resource", + "name": "resourceid", "type": "string" }, { @@ -84534,13 +86166,13 @@ "type": "string" }, { - "description": "the account name for the account that owns the object being acted on in the event (e.g. the owner of the virtual machine, ip address, or security group)", - "name": "account", + "description": "the ID of the event", + "name": "id", "type": "string" }, { - "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" }, { @@ -84549,33 +86181,43 @@ "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": "the project name of the address", - "name": "project", + "description": "the date the event was created", + "name": "created", + "type": "date" + }, + { + "description": "the project id of the ipaddress", + "name": "projectid", "type": "string" }, { - "description": "the event level (INFO, WARN, ERROR)", - "name": "level", + "description": "the name of the resource", + "name": "resourcename", "type": "string" }, { - "description": "the date the event was created", - "name": "created", - "type": "date" + "description": "the id of the account's domain", + "name": "domainid", + "type": "string" }, { - "description": "the ID of the event", - "name": "id", + "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": "a brief description of the event", - "name": "description", + "description": "the account name for the account that owns the object being acted on in the event (e.g. the owner of the virtual machine, ip address, or security group)", + "name": "account", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -84583,11 +86225,18 @@ "name": "type", "type": "string" }, + {}, { - "description": "the name of the user who performed the action (can be different from the account if an admin is performing an action for a user, e.g. starting/stopping a user's virtual machine)", - "name": "username", + "description": "the project name of the address", + "name": "project", "type": "string" - } + }, + { + "description": "the state of the event", + "name": "state", + "type": "state" + }, + {} ] }, { @@ -84604,17 +86253,17 @@ "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": "comma separated list of affinity groups id that are going to be applied to the virtual machine. Should be passed only when vm is created from a zone with Basic Network support. Mutually exclusive with securitygroupnames parameter", "length": 255, - "name": "affinitygroupnames", + "name": "affinitygroupids", "related": "", "required": false, "type": "list" }, { - "description": "comma separated list of affinity groups id that are going to be applied to the virtual machine. Should be passed only when vm is created from a zone with Basic Network support. Mutually exclusive with securitygroupnames parameter", + "description": "comma separated list of affinity groups names that are going to be applied to the virtual machine. Should be passed only when vm is created from a zone with Basic Network support. Mutually exclusive with securitygroupids parameter", "length": 255, - "name": "affinitygroupids", + "name": "affinitygroupnames", "related": "", "required": false, "type": "list" @@ -84623,119 +86272,103 @@ "related": "recoverVirtualMachine,attachIso,destroyVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,startVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance", "response": [ { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", - "type": "string" - }, - { - "description": "the read (bytes) of disk on the vm", - "name": "diskkbsread", - "type": "long" + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", + "type": "boolean" }, { - "description": "the project id of the vm", - "name": "projectid", + "description": "the project name of the vm", + "name": "project", "type": "string" }, { - "description": "the name of the disk offering of the virtual machine", - "name": "diskofferingname", + "description": "the group ID of the virtual machine", + "name": "groupid", "type": "string" }, { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" - }, - { - "description": "the 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": "Guest vm Boot Type", - "name": "boottype", - "type": "string" + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" }, { - "description": "the account associated with the virtual machine", - "name": "account", - "type": "string" + "description": "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", + "description": "Guest vm Boot Mode", + "name": "bootmode", "type": "string" }, { - "description": "the target memory in vm", + "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": "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 incoming network traffic on the vm", - "name": "networkkbsread", + "description": "device ID of the root volume", + "name": "rootdeviceid", "type": "long" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", - "type": "string" + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" }, - {}, { - "description": "the user's name who deployed the virtual machine", - "name": "username", + "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", + "description": "Guest vm Boot Type", + "name": "boottype", "type": "string" }, { - "description": "OS name of the vm", - "name": "osdisplayname", + "description": "OS type id of the vm", + "name": "ostypeid", "type": "string" }, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", + "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": "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 name of the virtual machine", - "name": "name", - "type": "string" + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" }, { - "description": "OS type id of the vm", - "name": "ostypeid", + "description": "the ID of the host for the virtual machine", + "name": "hostid", "type": "string" }, { @@ -84744,222 +86377,114 @@ "type": "long" }, { - "description": "the name of the host for the virtual machine", - "name": "hostname", - "type": "string" - }, - { - "description": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", - "response": [ - { - "description": "the description of the affinity group", - "name": "description", - "type": "string" - }, - { - "description": "the domain name of the affinity group", - "name": "domain", - "type": "string" - }, - { - "description": "the project ID of the affinity group", - "name": "projectid", - "type": "string" - }, - { - "description": "the account owning the affinity group", - "name": "account", - "type": "string" - }, - { - "description": "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 domain ID of the affinity group", - "name": "domainid", - "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" - } - ], - "type": "set" - }, - { - "description": "the vgpu type used by the virtual machine", - "name": "vgpu", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "State of the Service from LB rule", - "name": "servicestate", + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", "type": "string" }, { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", "type": "boolean" }, { - "description": "the project name of the vm", - "name": "project", - "type": "string" - }, - { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "device type of the root volume", + "name": "rootdevicetype", "type": "string" }, { - "description": "the write (bytes) of disk on the vm", - "name": "diskkbswrite", - "type": "long" + "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", + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", "type": "string" }, { - "description": "the list of resource tags associated", - "name": "tags", + "description": "list of security groups associated with the virtual machine", + "name": "securitygroup", "response": [ { - "description": "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 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 list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + } + ], + "type": "set" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the description of the security group", + "name": "description", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the ID of the security group", + "name": "id", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the project id of the group", + "name": "projectid", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", - "type": "string" - }, - { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" - }, - { - "description": "the number of cpu this virtual machine is running with", - "name": "cpunumber", - "type": "integer" - }, - { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", - "type": "string" - }, - { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", - "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 group name of the virtual machine", - "name": "group", - "type": "string" - }, - { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", - "type": "string" - }, - {}, - { - "description": "the speed of each cpu", - "name": "cpuspeed", - "type": "integer" - }, - { - "description": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" - }, - { - "description": "list of security groups associated with the virtual machine", - "name": "securitygroup", - "response": [ - { - "description": "the project id of the group", - "name": "projectid", + "description": "the domain name of the security group", + "name": "domain", "type": "string" }, { @@ -84967,23 +86492,18 @@ "name": "ingressrule", "response": [ { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", + "description": "the code for the ICMP message response", + "name": "icmpcode", "type": "integer" }, { - "description": "security group name", - "name": "securitygroupname", - "type": "string" + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" }, { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", + "description": "the id of the security group rule", + "name": "ruleid", "type": "string" }, { @@ -84991,13 +86511,13 @@ "name": "tags", "response": [ { - "description": "tag key name", - "name": "key", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { @@ -85006,18 +86526,18 @@ "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "tag key name", + "name": "key", "type": "string" }, { @@ -85026,13 +86546,13 @@ "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": "the account associated with the tag", + "name": "account", "type": "string" }, { @@ -85044,8 +86564,8 @@ "type": "set" }, { - "description": "the ending IP of the security group rule ", - "name": "endport", + "description": "the type of the ICMP message response", + "name": "icmptype", "type": "integer" }, { @@ -85059,78 +86579,41 @@ "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" - }, - { - "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 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 ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", - "type": "string" + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "security group name", + "name": "securitygroupname", "type": "string" } ], "type": "set" }, { - "description": "the domain name of the security group", - "name": "domain", + "description": "the project name of the group", + "name": "project", + "type": "string" + }, + { + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" + }, + { + "description": "the name of the security group", + "name": "name", + "type": "string" + }, + { + "description": "the domain ID of the security group", + "name": "domainid", "type": "string" }, { @@ -85139,71 +86622,76 @@ "type": "integer" }, { - "description": "the project name of the group", - "name": "project", + "description": "the account owning the security group", + "name": "account", "type": "string" }, - { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" - }, { "description": "the list of egress rules associated with the security group", "name": "egressrule", "response": [ { - "description": "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", + "description": "the id of the security group rule", + "name": "ruleid", "type": "string" }, { - "description": "the protocol of the security group rule", - "name": "protocol", + "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 starting IP of the security group rule", - "name": "startport", - "type": "integer" + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "tag value", - "name": "value", + "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": "resource type", - "name": "resourcetype", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { @@ -85212,102 +86700,139 @@ "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "resource type", + "name": "resourcetype", "type": "string" } ], "type": "set" }, { - "description": "the id of the security group rule", - "name": "ruleid", + "description": "the protocol of the security group rule", + "name": "protocol", "type": "string" }, { "description": "the code for the ICMP message response", "name": "icmpcode", "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" + } + ], + "type": "set" + }, + { + "description": "the ID of the availablility zone for the virtual machine", + "name": "zoneid", + "type": "string" + }, + { + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", + "type": "string" + }, + { + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" + }, + { + "description": "Os type ID of the virtual machine", + "name": "guestosid", + "type": "string" + }, + { + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" }, { - "description": "the ID of the security group", - "name": "id", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the name of the security group", - "name": "name", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the account owning the security group", + "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 value", + "name": "value", + "type": "string" + }, + { + "description": "the account associated with the tag", "name": "account", "type": "string" }, { - "description": "the domain ID of the security group", - "name": "domainid", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the description of the security group", - "name": "description", + "description": "id of the resource", + "name": "resourceid", "type": "string" } ], "type": "set" }, { - "description": "the group ID of the virtual machine", - "name": "groupid", + "description": "the ID of the virtual machine", + "name": "id", "type": "string" }, { - "description": "the outgoing network traffic on the host", - "name": "networkkbswrite", - "type": "long" - }, - { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", "type": "string" }, { - "description": "the state of the virtual machine", - "name": "state", + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", "type": "string" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", "type": "string" }, { @@ -85315,54 +86840,143 @@ "name": "pooltype", "type": "string" }, + {}, { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", + "description": "State of the Service from LB rule", + "name": "servicestate", "type": "string" }, { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" + }, + { + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", "type": "boolean" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { - "description": "the 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": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", - "type": "boolean" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the ID of the virtual machine", - "name": "id", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, + {}, { - "description": "Guest vm Boot Mode", - "name": "bootmode", + "description": "the name of the disk offering of the virtual machine", + "name": "diskofferingname", "type": "string" }, { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" + "description": "the name of the template for the virtual machine", + "name": "templatename", + "type": "string" }, { - "description": "the ID of the availablility zone for the virtual machine", - "name": "zoneid", + "description": "the account associated with the virtual machine", + "name": "account", "type": "string" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" + }, + { + "description": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", + "response": [ + { + "description": "the ID of the affinity group", + "name": "id", + "type": "string" + }, + { + "description": "the description of the affinity group", + "name": "description", + "type": "string" + }, + { + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" + }, + { + "description": "the domain ID of the affinity group", + "name": "domainid", + "type": "string" + }, + { + "description": "the account owning the affinity group", + "name": "account", + "type": "string" + }, + { + "description": "the project ID of the affinity group", + "name": "projectid", + "type": "string" + }, + { + "description": "the type of the affinity group", + "name": "type", + "type": "string" + }, + { + "description": "the name of the affinity group", + "name": "name", + "type": "string" + }, + { + "description": "the domain name of the affinity group", + "name": "domain", + "type": "string" + }, + { + "description": "the project name of the affinity group", + "name": "project", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", + "type": "string" + }, + { + "description": "the password (if exists) of the virtual machine", + "name": "password", + "type": "string" + }, + { + "description": "OS name of the vm", + "name": "osdisplayname", + "type": "string" + }, + { + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" + }, + { + "description": "the user's name who deployed the virtual machine", + "name": "username", "type": "string" }, { @@ -85371,108 +86985,138 @@ "type": "boolean" }, { - "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": "publicip", "type": "string" }, { - "description": "the memory used by the vm", - "name": "memorykbs", + "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 vGPU type used by the virtual machine", + "name": "vgpu", "type": "string" }, { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", - "type": "boolean" + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" }, { - "description": "ssh key-pair", - "name": "keypair", + "description": "the project id of the vm", + "name": "projectid", "type": "string" }, { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, - {}, { - "description": "the internal memory that's free in vm or zero if it can not be calculated", - "name": "memoryintfreekbs", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", "type": "long" }, { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", "type": "string" }, { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" + "description": "the memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" }, { - "description": "the read (io) of disk on the vm", - "name": "diskioread", + "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", "type": "long" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" + "description": "ssh key-pairs", + "name": "keypairs", + "type": "string" + }, + { + "description": "the state of the virtual machine", + "name": "state", + "type": "string" + }, + {}, + { + "description": "the group name of the virtual machine", + "name": "group", + "type": "string" }, { "description": "the list of nics associated with vm", "name": "nic", "response": [ { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "the broadcast uri of the nic", + "name": "broadcasturi", + "type": "string" }, { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", + "type": "string" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "the ID of the nic", - "name": "id", + "description": "true if nic is default, false otherwise", + "name": "macaddress", "type": "string" }, + { + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, { "description": "the traffic type of the nic", "name": "traffictype", "type": "string" }, { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "the netmask of the nic", + "name": "netmask", "type": "string" }, { - "description": "the ip address of the nic", - "name": "ipaddress", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "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" }, { @@ -85481,33 +87125,33 @@ "type": "integer" }, { - "description": "the netmask of the nic", - "name": "netmask", - "type": "string" + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", - "type": "string" + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" }, { - "description": "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 IPv6 address of network", - "name": "ip6address", + "description": "Type of adapter if available", + "name": "adaptertype", "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 gateway of IPv6 network", - "name": "ip6gateway", + "description": "the ID of the nic", + "name": "id", "type": "string" }, { @@ -85516,8 +87160,8 @@ "type": "string" }, { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "the IPv6 address of network", + "name": "ip6address", "type": "string" }, { @@ -85526,19 +87170,19 @@ "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 VLAN/VNI if available", - "name": "vlanid", - "type": "integer" + "description": "the gateway of the nic", + "name": "gateway", + "type": "string" }, { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", + "type": "string" }, { "description": "the isolation uri of the nic", @@ -85546,31 +87190,46 @@ "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the ip address of the nic", + "name": "ipaddress", "type": "string" }, { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", "type": "string" }, { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", "type": "string" } ], "type": "set" }, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", + "description": "the name of the host for the virtual machine", + "name": "hostname", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the name of the virtual machine", + "name": "name", + "type": "string" + }, + { + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", + "type": "string" + }, + { + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" } ] @@ -85590,9 +87249,15 @@ ], "related": "configureHAForHost,disableHAForHost", "response": [ + {}, { - "description": "the host HA provider", - "name": "haprovider", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -85600,32 +87265,26 @@ "name": "hostid", "type": "string" }, - {}, { "description": "if host HA is enabled for the host", "name": "haenable", "type": "boolean" }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "operation status", "name": "status", "type": "boolean" }, {}, + { + "description": "the host HA provider", + "name": "haprovider", + "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" } ], "since": "4.11" @@ -85636,48 +87295,48 @@ "name": "registerNetscalerServicePackage", "params": [ { - "description": "Description of Service Package", + "description": "Name of the service Package.", "length": 255, - "name": "description", + "name": "name", "required": true, "type": "string" }, { - "description": "Name of the service Package.", + "description": "Description of Service Package", "length": 255, - "name": "name", + "name": "description", "required": true, "type": "string" } ], "related": "listRegisteredServicePackages", "response": [ - { - "description": "Service Package Name", - "name": "name", - "type": "string" - }, { "description": "Description of Service Package", "name": "description", "type": "string" }, - { - "description": "Service Package UUID", - "name": "id", - "type": "string" - }, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" + }, + {}, + {}, + { + "description": "Service Package Name", + "name": "name", + "type": "string" + }, + { + "description": "Service Package UUID", + "name": "id", + "type": "string" } ] }, @@ -85686,13 +87345,6 @@ "isasync": true, "name": "createTags", "params": [ - { - "description": "list of resources to create the tags for", - "length": 255, - "name": "resourceids", - "required": true, - "type": "list" - }, { "description": "Map of tags (key/value pairs)", "length": 255, @@ -85713,10 +87365,16 @@ "name": "resourcetype", "required": true, "type": "string" + }, + { + "description": "list of resources to create the tags for", + "length": 255, + "name": "resourceids", + "required": true, + "type": "list" } ], "response": [ - {}, { "description": "any text associated with the success or failure", "name": "displaytext", @@ -85733,6 +87391,7 @@ "name": "success", "type": "boolean" }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", @@ -85746,13 +87405,6 @@ "isasync": true, "name": "configureSrxFirewall", "params": [ - { - "description": "capacity of the firewall device, Capacity will be interpreted as number of networks device can handle", - "length": 255, - "name": "fwdevicecapacity", - "required": false, - "type": "long" - }, { "description": "SRX firewall device ID", "length": 255, @@ -85760,13 +87412,25 @@ "related": "configureSrxFirewall", "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": "", "response": [ { - "description": "the username that's used to log in to the external firewall", - "name": "username", + "description": "the physical network to which this SRX firewall belongs to", + "name": "physicalnetworkid", + "type": "string" + }, + { + "description": "the usage interface of the external firewall", + "name": "usageinterface", "type": "string" }, { @@ -85774,6 +87438,21 @@ "name": "provider", "type": "string" }, + { + "description": "device name", + "name": "fwdevicename", + "type": "string" + }, + { + "description": "device id of the SRX firewall", + "name": "fwdeviceid", + "type": "string" + }, + { + "description": "the timeout (in seconds) for requests to the external firewall", + "name": "timeout", + "type": "string" + }, { "description": "the number of times to retry requests to the external firewall", "name": "numretries", @@ -85784,10 +87463,14 @@ "name": "fwdevicecapacity", "type": "long" }, - {}, { - "description": "device id of the SRX firewall", - "name": "fwdeviceid", + "description": "the private security zone of the external firewall", + "name": "privatezone", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -85796,8 +87479,14 @@ "type": "string" }, { - "description": "the physical network to which this SRX firewall belongs to", - "name": "physicalnetworkid", + "description": "device state", + "name": "fwdevicestate", + "type": "string" + }, + {}, + { + "description": "the username that's used to log in to the external firewall", + "name": "username", "type": "string" }, { @@ -85811,20 +87500,43 @@ "type": "string" }, { - "description": "the public security zone of the external firewall", - "name": "publiczone", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the private security zone of the external firewall", - "name": "privatezone", + "description": "the zone ID of the external firewall", + "name": "zoneid", "type": "string" }, {}, { - "description": "the zone ID of the external firewall", - "name": "zoneid", + "description": "the public security zone of the external firewall", + "name": "publiczone", "type": "string" + } + ] + }, + { + "description": "Create an Internal Load Balancer element.", + "isasync": true, + "name": "createInternalLoadBalancerElement", + "params": [ + { + "description": "the network service provider ID of the internal load balancer element", + "length": 255, + "name": "nspid", + "related": "listNetworkServiceProviders", + "required": true, + "type": "uuid" + } + ], + "related": "configureInternalLoadBalancerElement", + "response": [ + { + "description": "Enabled/Disabled the element", + "name": "enabled", + "type": "boolean" }, { "description": "the current status of the latest async job acting on this object", @@ -85832,31 +87544,24 @@ "type": "integer" }, { - "description": "device name", - "name": "fwdevicename", - "type": "string" - }, - { - "description": "the timeout (in seconds) for requests to the external firewall", - "name": "timeout", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the usage interface of the external firewall", - "name": "usageinterface", + "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 id of the internal load balancer element", + "name": "id", "type": "string" }, - { - "description": "device state", - "name": "fwdevicestate", - "type": "string" - } - ] + {} + ], + "since": "4.2.0" }, { "description": "Lists the CA public certificate(s) as support by the configured/provided CA plugin", @@ -85873,6 +87578,11 @@ ], "related": "", "response": [ + { + "description": "The client certificate", + "name": "certificate", + "type": "string" + }, {}, { "description": "the current status of the latest async job acting on this object", @@ -85880,8 +87590,8 @@ "type": "integer" }, { - "description": "The client certificate", - "name": "certificate", + "description": "The CA certificate(s)", + "name": "cacertificates", "type": "string" }, { @@ -85889,40 +87599,35 @@ "name": "privatekey", "type": "string" }, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - { - "description": "The CA certificate(s)", - "name": "cacertificates", - "type": "string" - } + {} ], "since": "4.11.0" }, { - "description": "Create an Internal Load Balancer element.", - "isasync": true, - "name": "createInternalLoadBalancerElement", + "description": "Reset api count", + "isasync": false, + "name": "resetApiLimit", "params": [ { - "description": "the network service provider ID of the internal load balancer element", + "description": "the ID of the acount whose limit to be reset", "length": 255, - "name": "nspid", - "related": "listNetworkServiceProviders", - "required": true, + "name": "account", + "related": "enableAccount,listAccounts,listAccounts", + "required": false, "type": "uuid" } ], - "related": "configureInternalLoadBalancerElement", "response": [ + {}, { - "description": "Enabled/Disabled the element", - "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", @@ -85934,41 +87639,36 @@ "name": "jobid", "type": "string" }, - { - "description": "the physical network service provider id of the element", - "name": "nspid", - "type": "string" - }, - { - "description": "the id of the internal load balancer element", - "name": "id", - "type": "string" - }, {}, - {} - ], - "since": "4.2.0" + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + } + ] }, { - "description": "Reset api count", + "description": "Creates a VLAN IP range.", "isasync": false, - "name": "resetApiLimit", + "name": "deleteVlanIpRange", "params": [ { - "description": "the ID of the acount whose limit to be reset", + "description": "the id of the VLAN IP range", "length": 255, - "name": "account", - "related": "enableAccount,listAccounts,listAccounts", - "required": false, + "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": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" }, + {}, + {}, { "description": "true if operation is executed successfully", "name": "success", @@ -85979,38 +87679,50 @@ "name": "jobid", "type": "string" }, - {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - }, - {} + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } ] }, { - "description": "Creates a VLAN IP range.", + "description": "Provisions a host with a direct download certificate", "isasync": false, - "name": "deleteVlanIpRange", + "name": "provisionTemplateDirectDownloadCertificate", "params": [ { - "description": "the id of the VLAN IP range", + "description": "the host to provision the certificate", + "length": 255, + "name": "hostid", + "related": "addBaremetalHost,cancelHostAsDegraded,reconnectHost", + "required": true, + "type": "uuid" + }, + { + "description": "the id of the direct download certificate to provision", "length": 255, "name": "id", - "related": "dedicatePublicIpRange", + "related": "uploadTemplateDirectDownloadCertificate", "required": true, "type": "uuid" } ], + "related": "", "response": [ { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "indicates if the certificate has been revoked from the host, failed or skipped", + "name": "status", + "type": "string" + }, + { + "description": "the name of the host", + "name": "hostname", "type": "string" }, {}, @@ -86019,168 +87731,167 @@ "name": "jobid", "type": "string" }, + { + "description": "the ID of the host", + "name": "hostid", + "type": "string" + }, {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "indicates the details in case of failure or host skipped", + "name": "details", + "type": "string" } - ] + ], + "since": "4.17.0" }, { - "description": "Creates a Project role", - "isasync": false, - "name": "updateProjectRole", + "description": "Generates an alert", + "isasync": true, + "name": "generateAlert", "params": [ { - "description": "ID of the Project role", + "description": "Type of the alert", "length": 255, - "name": "id", - "related": "updateProjectRole", + "name": "type", "required": true, - "type": "uuid" + "type": "short" }, { - "description": "ID of project where role is being created", + "description": "Pod id for which alert is generated", "length": 255, - "name": "projectid", - "related": "activateProject,suspendProject", - "required": true, + "name": "podid", + "related": "updatePod,createManagementNetworkIpRange", + "required": false, "type": "uuid" }, { - "description": "creates a project role with this unique name", + "description": "Zone id for which alert is generated", "length": 255, - "name": "name", + "name": "zoneid", + "related": "createZone,listZones", "required": false, + "type": "uuid" + }, + { + "description": "Alert description", + "length": 999, + "name": "description", + "required": true, "type": "string" }, { - "description": "The description of the Project role", + "description": "Name of the alert", "length": 255, - "name": "description", - "required": false, + "name": "name", + "required": true, "type": "string" } ], - "related": "", "response": [ + {}, { - "description": "the ID of the role", - "name": "id", - "type": "string" - }, - { - "description": "the description of the role", - "name": "description", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the id of the project", - "name": "projectid", - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, {}, - {}, { - "description": "the name of the role", - "name": "name", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" } ], - "since": "4.15.0" + "since": "4.3" }, { - "description": "Generates an alert", - "isasync": true, - "name": "generateAlert", + "description": "Creates a Project role", + "isasync": false, + "name": "updateProjectRole", "params": [ { - "description": "Type of the alert", - "length": 255, - "name": "type", - "required": true, - "type": "short" - }, - { - "description": "Zone id for which alert is generated", + "description": "The description of the Project role", "length": 255, - "name": "zoneid", - "related": "createZone,listZones", + "name": "description", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "Pod id for which alert is generated", + "description": "ID of project where role is being created", "length": 255, - "name": "podid", - "related": "updatePod,createManagementNetworkIpRange", - "required": false, + "name": "projectid", + "related": "activateProject,suspendProject", + "required": true, "type": "uuid" }, { - "description": "Alert description", - "length": 999, - "name": "description", + "description": "ID of the Project role", + "length": 255, + "name": "id", + "related": "updateProjectRole", "required": true, - "type": "string" + "type": "uuid" }, { - "description": "Name of the alert", + "description": "creates a project role with this unique name", "length": 255, "name": "name", - "required": true, + "required": false, "type": "string" } ], + "related": "", "response": [ + { + "description": "the id of the project", + "name": "projectid", + "type": "string" + }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "the name of the role", + "name": "name", + "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": "the ID of the role", + "name": "id", + "type": "string" } ], - "since": "4.3" + "since": "4.15.0" }, { "description": "Add a new Ldap Configuration", "isasync": false, "name": "addLdapConfiguration", "params": [ - { - "description": "Port", - "length": 255, - "name": "port", - "required": true, - "type": "integer" - }, { "description": "linked domain", "length": 255, @@ -86195,14 +87906,25 @@ "name": "hostname", "required": true, "type": "string" + }, + { + "description": "Port", + "length": 255, + "name": "port", + "required": true, + "type": "integer" } ], "related": "", "response": [ - {}, { - "description": "linked domain", - "name": "domainid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "name of the host running the ldap server", + "name": "hostname", "type": "string" }, { @@ -86210,20 +87932,16 @@ "name": "jobstatus", "type": "integer" }, + {}, { - "description": "port teh ldap server is running on", - "name": "port", - "type": "int" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "linked domain", + "name": "domainid", "type": "string" }, { - "description": "name of the host running the ldap server", - "name": "hostname", - "type": "string" + "description": "port teh ldap server is running on", + "name": "port", + "type": "int" }, {} ], @@ -86242,23 +87960,9 @@ "type": "string" }, { - "description": "Hostname or ip address of the ldap server eg: my.ldap.com", - "length": 255, - "name": "hostname", - "required": false, - "type": "string" - }, - { - "description": "Specify the distinguished name of a user with the search permission on the directory.", - "length": 255, - "name": "binddn", - "required": false, - "type": "string" - }, - { - "description": "You specify a query filter here, which narrows down the users, who can be part of this domain.", + "description": "The search base defines the starting point for the search in the directory tree Example: dc=cloud,dc=com.", "length": 255, - "name": "queryfilter", + "name": "searchbase", "required": false, "type": "string" }, @@ -86284,18 +87988,18 @@ "type": "boolean" }, { - "description": "The search base defines the starting point for the search in the directory tree Example: dc=cloud,dc=com.", + "description": "Specify the LDAP port if required, default is 389.", "length": 255, - "name": "searchbase", + "name": "port", "required": false, - "type": "string" + "type": "integer" }, { - "description": "Specify the LDAP port if required, default is 389.", + "description": "Specify the distinguished name of a user with the search permission on the directory.", "length": 255, - "name": "port", + "name": "binddn", "required": false, - "type": "integer" + "type": "string" }, { "description": "Enter the password.", @@ -86303,56 +88007,70 @@ "name": "bindpass", "required": false, "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, + "type": "string" + }, + { + "description": "Hostname or ip address of the ldap server eg: my.ldap.com", + "length": 255, + "name": "hostname", + "required": false, + "type": "string" } ], "related": "ldapRemove", "response": [ { - "description": "Hostname or ip address of the ldap server eg: my.ldap.com", - "name": "hostname", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "The search base defines the starting point for the search in the directory tree Example: dc=cloud,dc=com", - "name": "searchbase", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "Check Use SSL if the external LDAP server is configured for LDAP over SSL", - "name": "ssl", + "description": "Hostname or ip address of the ldap server eg: my.ldap.com", + "name": "hostname", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "DN password", + "name": "bindpass", "type": "string" }, { - "description": "Specify the LDAP port if required, default is 389", - "name": "port", + "description": "You specify a query filter here, which narrows down the users, who can be part of this domain", + "name": "queryfilter", "type": "string" }, { - "description": "You specify a query filter here, which narrows down the users, who can be part of this domain", - "name": "queryfilter", + "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": "Specify the distinguished name of a user with the search permission on the directory", "name": "binddn", "type": "string" }, + {}, { - "description": "DN password", - "name": "bindpass", + "description": "Check Use SSL if the external LDAP server is configured for LDAP over SSL", + "name": "ssl", "type": "string" }, {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "Specify the LDAP port if required, default is 389", + "name": "port", + "type": "string" } ], "since": "3.0.0" @@ -86374,29 +88092,24 @@ "related": "", "response": [ { - "description": "the identifier of the Storage Policy in vSphere DataCenter", - "name": "policyid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the ID of the Zone", - "name": "zoneid", + "description": "the identifier of the Storage Policy in vSphere DataCenter", + "name": "policyid", "type": "string" }, {}, { - "description": "the ID of the Storage Policy", - "name": "id", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the ID of the Zone", + "name": "zoneid", "type": "string" }, { - "description": "the name of the Storage Policy", - "name": "name", + "description": "the description of the Storage Policy", + "name": "description", "type": "string" }, { @@ -86404,10 +88117,15 @@ "name": "jobstatus", "type": "integer" }, + { + "description": "the ID of the Storage Policy", + "name": "id", + "type": "string" + }, {}, { - "description": "the description of the Storage Policy", - "name": "description", + "description": "the name of the Storage Policy", + "name": "name", "type": "string" } ] @@ -86421,12 +88139,13 @@ "description": "the ID of the port forwarding rule", "length": 255, "name": "id", - "related": "", + "related": "updateIpv6FirewallRule", "required": true, "type": "uuid" } ], "response": [ + {}, { "description": "any text associated with the success or failure", "name": "displaytext", @@ -86447,8 +88166,7 @@ "description": "true if operation is executed successfully", "name": "success", "type": "boolean" - }, - {} + } ] }, { @@ -86456,13 +88174,6 @@ "isasync": true, "name": "migrateVPC", "params": [ - { - "description": "network offering ids for each network in the vpc. Example: tierNetworkOfferings[0].networkId=networkId1&tierNetworkOfferings[0].networkOfferingId=newNetworkofferingId1&tierNetworkOfferings[1].networkId=networkId2&tierNetworkOfferings[1].networkOfferingId=newNetworkofferingId2", - "length": 255, - "name": "tiernetworkofferings", - "required": false, - "type": "map" - }, { "description": "the ID of the vpc", "length": 255, @@ -86479,6 +88190,13 @@ "required": true, "type": "uuid" }, + { + "description": "network offering ids for each network in the vpc. Example: tierNetworkOfferings[0].networkId=networkId1&tierNetworkOfferings[0].networkOfferingId=newNetworkofferingId1&tierNetworkOfferings[1].networkId=networkId2&tierNetworkOfferings[1].networkOfferingId=newNetworkofferingId2", + "length": 255, + "name": "tiernetworkofferings", + "required": false, + "type": "map" + }, { "description": "true if previous network migration cmd failed", "length": 255, @@ -86490,115 +88208,8 @@ "related": "createVPC,listVPCs,updateVPC", "response": [ { - "description": "the list of supported services", - "name": "service", - "response": [ - { - "description": "the service name", - "name": "name", - "type": "string" - }, - { - "description": "the service provider name", - "name": "provider", - "response": [ - { - "description": "true if individual services can be enabled/disabled", - "name": "canenableindividualservice", - "type": "boolean" - }, - { - "description": "services for this provider", - "name": "servicelist", - "type": "list" - }, - { - "description": "the destination physical network", - "name": "destinationphysicalnetworkid", - "type": "string" - }, - { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", - "type": "string" - }, - { - "description": "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" - } - ], - "type": "list" - }, - { - "description": "the list of capabilities", - "name": "capability", - "response": [ - { - "description": "the capability name", - "name": "name", - "type": "string" - }, - { - "description": "the capability value", - "name": "value", - "type": "string" - }, - { - "description": "can this service capability value can be choosable while creatine network offerings", - "name": "canchooseservicecapability", - "type": "boolean" - } - ], - "type": "list" - } - ], - "type": "list" - }, - { - "description": "the project id of the VPC", - "name": "projectid", - "type": "string" - }, - { - "description": "vpc offering id the VPC is created from", - "name": "vpcofferingid", - "type": "string" - }, - { - "description": "the domain id of the VPC owner", - "name": "domainid", - "type": "string" - }, - {}, - { - "description": "zone id of the vpc", - "name": "zoneid", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the id of the VPC", - "name": "id", + "description": "state of the VPC. Can be Inactive/Enabled", + "name": "state", "type": "string" }, { @@ -86607,9 +88218,9 @@ "type": "boolean" }, { - "description": "true if VPC is region level", - "name": "regionlevelvpc", - "type": "boolean" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { "description": "the domain name of the owner", @@ -86617,54 +88228,29 @@ "type": "string" }, { - "description": "the date this VPC was created", - "name": "created", - "type": "date" - }, - { - "description": "the network domain of the VPC", - "name": "networkdomain", - "type": "string" - }, - { - "description": "the cidr the VPC", - "name": "cidr", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, { - "description": "if this VPC has redundant router", - "name": "redundantvpcrouter", - "type": "boolean" - }, - { - "description": "state of the VPC. Can be Inactive/Enabled", - "name": "state", - "type": "string" + "description": "The routes for the network to ease adding route in upstream router", + "name": "ip6routes", + "type": "set" }, { - "description": "the owner of the VPC", - "name": "account", + "description": "the network domain of the VPC", + "name": "networkdomain", "type": "string" }, - {}, { - "description": "is vpc for display to the regular user", - "name": "fordisplay", + "description": "is VPC uses distributed router for one hop forwarding and host based network ACL's", + "name": "distributedvpcrouter", "type": "boolean" }, { - "description": "the list of networks belongign to the VPC", - "name": "network", - "type": "list" - }, - { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "the project name of the VPC", - "name": "project", + "description": "the domain id of the VPC owner", + "name": "domainid", "type": "string" }, { @@ -86672,15 +88258,15 @@ "name": "vpcofferingname", "type": "string" }, + { + "description": "vpc offering id the VPC is created from", + "name": "vpcofferingid", + "type": "string" + }, { "description": "the list of resource tags associated with the project", "name": "tags", "response": [ - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, { "description": "customer associated with the tag", "name": "customer", @@ -86692,8 +88278,8 @@ "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "tag key name", + "name": "key", "type": "string" }, { @@ -86701,19 +88287,14 @@ "name": "domain", "type": "string" }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, { "description": "tag value", "name": "value", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { @@ -86722,37 +88303,179 @@ "type": "string" }, { - "description": "resource type", - "name": "resourcetype", - "type": "string" + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + } + ], + "type": "list" + }, + { + "description": "the cidr the VPC", + "name": "cidr", + "type": "string" + }, + { + "description": "the owner of the VPC", + "name": "account", + "type": "string" + }, + { + "description": "an alternate display text of the VPC.", + "name": "displaytext", + "type": "string" + }, + { + "description": "the list of supported services", + "name": "service", + "response": [ + { + "description": "the service name", + "name": "name", + "type": "string" + }, + { + "description": "the service provider name", + "name": "provider", + "response": [ + { + "description": "services for this provider", + "name": "servicelist", + "type": "list" + }, + { + "description": "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": "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" + } + ], + "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": "an alternate display text of the VPC.", - "name": "displaytext", + "description": "the id of the VPC", + "name": "id", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "the name of the VPC", + "name": "name", + "type": "string" + }, + { + "description": "true if VPC is region level", + "name": "regionlevelvpc", "type": "boolean" }, { - "description": "is VPC uses distributed router for one hop forwarding and host based network ACL's", - "name": "distributedvpcrouter", + "description": "the list of networks belongign to the VPC", + "name": "network", + "type": "list" + }, + { + "description": "the project name of the VPC", + "name": "project", + "type": "string" + }, + {}, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "the name of the VPC", - "name": "name", + "description": "the project id of the VPC", + "name": "projectid", "type": "string" }, { "description": "the name of the zone the VPC belongs to", "name": "zonename", "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "if this VPC has redundant router", + "name": "redundantvpcrouter", + "type": "boolean" + }, + { + "description": "zone id of the vpc", + "name": "zoneid", + "type": "string" + }, + { + "description": "is vpc for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, + { + "description": "the date this VPC was created", + "name": "created", + "type": "date" } ], "since": "4.11.0" @@ -86772,28 +88495,28 @@ } ], "response": [ - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, + {}, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" }, - { - "description": "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" + } ] }, { @@ -86802,30 +88525,31 @@ "name": "updateAnnotationVisibility", "params": [ { - "description": "the annotation is visible for admins only", + "description": "the id of the annotation", "length": 255, - "name": "adminsonly", + "name": "id", "required": true, - "type": "boolean" + "type": "string" }, { - "description": "the id of the annotation", + "description": "the annotation is visible for admins only", "length": 255, - "name": "id", + "name": "adminsonly", "required": true, - "type": "string" + "type": "boolean" } ], "related": "removeAnnotation", "response": [ + {}, { - "description": "the type of the annotated entity", - "name": "entitytype", + "description": "the contents of the annotation", + "name": "annotation", "type": "string" }, { - "description": "The (uu)id of the user that entered the annotation", - "name": "userid", + "description": "the (uu)id of the entitiy to which this annotation pertains", + "name": "entityid", "type": "string" }, { @@ -86833,16 +88557,6 @@ "name": "entityname", "type": "string" }, - { - "description": "The username of the user that entered the annotation", - "name": "username", - "type": "string" - }, - { - "description": "the removal timestamp for this annotation", - "name": "removed", - "type": "date" - }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", @@ -86854,30 +88568,39 @@ "name": "jobstatus", "type": "integer" }, + { + "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": "the type of the annotated entity", + "name": "entitytype", + "type": "string" + }, { "description": "True if the annotation is available for admins only", "name": "adminsonly", "type": "boolean" }, - {}, { "description": "the (uu)id of the annotation", "name": "id", "type": "string" }, { - "description": "the contents of the annotation", - "name": "annotation", - "type": "string" - }, - { - "description": "the (uu)id of the entitiy to which this annotation pertains", - "name": "entityid", + "description": "The username of the user that entered the annotation", + "name": "username", "type": "string" }, { - "description": "the creation timestamp for this annotation", - "name": "created", + "description": "the removal timestamp for this annotation", + "name": "removed", "type": "date" } ], @@ -86889,12 +88612,11 @@ "name": "listBigSwitchBcfDevices", "params": [ { - "description": "the Physical Network ID", + "description": "", "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" }, { "description": "bigswitch BCF controller device ID", @@ -86912,16 +88634,17 @@ "type": "string" }, { - "description": "", + "description": "the Physical Network ID", "length": 255, - "name": "pagesize", + "name": "physicalnetworkid", + "related": "createPhysicalNetwork", "required": false, - "type": "integer" + "type": "uuid" }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" } @@ -86929,29 +88652,28 @@ "related": "", "response": [ { - "description": "device name", - "name": "bigswitchdevicename", + "description": "the controller username", + "name": "username", "type": "string" }, { - "description": "name of the provider", - "name": "provider", + "description": "device id of the BigSwitch BCF Controller", + "name": "bcfdeviceid", "type": "string" }, - {}, { - "description": "the physical network to which this BigSwitch BCF segment belongs to", - "name": "physicalnetworkid", + "description": "the controller Ip address", + "name": "hostname", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "device name", + "name": "bigswitchdevicename", "type": "string" }, { - "description": "the controller Ip address", - "name": "hostname", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -86959,27 +88681,28 @@ "name": "nat", "type": "boolean" }, + {}, + { + "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 controller username", - "name": "username", - "type": "string" - }, + {}, { "description": "the controller password", "name": "password", "type": "string" }, { - "description": "device id of the BigSwitch BCF Controller", - "name": "bcfdeviceid", + "description": "the physical network to which this BigSwitch BCF segment belongs to", + "name": "physicalnetworkid", "type": "string" - }, - {} + } ], "since": "4.6.0" }, @@ -86989,36 +88712,43 @@ "name": "updateConfiguration", "params": [ { - "description": "the value of the configuration", - "length": 4095, - "name": "value", - "required": false, + "description": "the name of the configuration", + "length": 255, + "name": "name", + "required": true, "type": "string" }, { - "description": "the ID of the Image Store to update the parameter value for corresponding image store", + "description": "the ID of the Account to update the parameter value for corresponding account", "length": 255, - "name": "imagestoreuuid", - "related": "listSwifts,addImageStoreS3,listImageStores", + "name": "accountid", + "related": "enableAccount,listAccounts,listAccounts", "required": false, "type": "uuid" }, { - "description": "the ID of the Zone to update the parameter value for corresponding zone", + "description": "the ID of the Storage pool to update the parameter value for corresponding storage pool", "length": 255, - "name": "zoneid", - "related": "createZone,listZones", + "name": "storageid", + "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool", "required": false, "type": "uuid" }, { - "description": "the ID of the Storage pool to update the parameter value for corresponding storage pool", + "description": "the ID of the Image Store to update the parameter value for corresponding image store", "length": 255, - "name": "storageid", - "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool", + "name": "imagestoreuuid", + "related": "listSwifts,addImageStoreS3,listImageStores", "required": false, "type": "uuid" }, + { + "description": "the value of the configuration", + "length": 4096, + "name": "value", + "required": false, + "type": "string" + }, { "description": "the ID of the Cluster to update the parameter value for corresponding cluster", "length": 255, @@ -87028,65 +88758,52 @@ "type": "uuid" }, { - "description": "the ID of the Domain to update the parameter value for corresponding domain", + "description": "the ID of the Zone to update the parameter value for corresponding zone", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", + "name": "zoneid", + "related": "createZone,listZones", "required": false, "type": "uuid" }, { - "description": "the ID of the Account to update the parameter value for corresponding account", + "description": "the ID of the Domain to update the parameter value for corresponding domain", "length": 255, - "name": "accountid", - "related": "enableAccount,listAccounts,listAccounts", + "name": "domainid", + "related": "listDomainChildren,listDomains", "required": false, "type": "uuid" - }, - { - "description": "the name of the configuration", - "length": 255, - "name": "name", - "required": true, - "type": "string" } ], "related": "", "response": [ - { - "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": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the category of the configuration", + "name": "category", "type": "string" }, - { - "description": "the value of the configuration", - "name": "id", - "type": "long" - }, { "description": "scope(zone/cluster/pool/account) of the parameter that needs to be updated", "name": "scope", "type": "string" }, - {}, { - "description": "the name of the configuration", - "name": "name", + "description": "the description of the configuration", + "name": "description", "type": "string" }, { - "description": "the description of the configuration", - "name": "description", + "description": "the value of the configuration", + "name": "value", + "type": "string" + }, + { + "description": "the name of the configuration", + "name": "name", "type": "string" }, { @@ -87094,11 +88811,17 @@ "name": "isdynamic", "type": "boolean" }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + {}, {}, { "description": "the value of the configuration", - "name": "value", - "type": "string" + "name": "id", + "type": "long" } ] }, @@ -87108,59 +88831,59 @@ "name": "configureHAForHost", "params": [ { - "description": "HA provider", + "description": "ID of the host", "length": 255, - "name": "provider", + "name": "hostid", + "related": "addBaremetalHost,cancelHostAsDegraded,reconnectHost", "required": true, - "type": "string" + "type": "uuid" }, { - "description": "ID of the host", + "description": "HA provider", "length": 255, - "name": "hostid", - "related": "cancelHostAsDegraded,reconnectHost,addBaremetalHost", + "name": "provider", "required": true, - "type": "uuid" + "type": "string" } ], "related": "disableHAForHost", "response": [ + {}, + {}, { "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": "the ID of the host", - "name": "hostid", + "description": "the host HA provider", + "name": "haprovider", "type": "string" }, - {}, { "description": "operation status", "name": "status", "type": "boolean" }, { - "description": "the host HA provider", - "name": "haprovider", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { "description": "if host HA is enabled for the host", "name": "haenable", "type": "boolean" + }, + { + "description": "the ID of the host", + "name": "hostid", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ], "since": "4.11" @@ -87179,12 +88902,11 @@ "type": "uuid" }, { - "description": "project who will own the VLAN", + "description": "account who will own the VLAN", "length": 255, - "name": "projectid", - "related": "activateProject,suspendProject", + "name": "account", "required": false, - "type": "uuid" + "type": "string" }, { "description": "domain ID of the account owning a VLAN", @@ -87195,49 +88917,54 @@ "type": "uuid" }, { - "description": "account who will own the VLAN", + "description": "project who will own the VLAN", "length": 255, - "name": "account", + "name": "projectid", + "related": "activateProject,suspendProject", "required": false, - "type": "string" + "type": "uuid" } ], "related": "", "response": [ { - "description": "the ID of the VLAN IP range", - "name": "id", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the gateway of the VLAN IP range", - "name": "gateway", + "description": "the start ipv6 of the VLAN IP range", + "name": "startipv6", "type": "string" }, - {}, { - "description": "the start ip of the VLAN IP range", - "name": "startip", + "description": "the end ipv6 of the VLAN IP range", + "name": "endipv6", "type": "string" }, { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", + "description": "the project name of the vlan range", + "name": "project", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the Pod ID for the VLAN IP range", + "name": "podid", "type": "string" }, { - "description": "indicates whether VLAN IP range is dedicated to system vms or not", - "name": "forsystemvms", - "type": "boolean" + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" }, { - "description": "the end ipv6 of the VLAN IP range", - "name": "endipv6", + "description": "the physical network this belongs to", + "name": "physicalnetworkid", + "type": "string" + }, + { + "description": "the start ip of the VLAN IP range", + "name": "startip", "type": "string" }, { @@ -87246,18 +88973,19 @@ "type": "string" }, { - "description": "the domain name of the VLAN IP range", - "name": "domain", + "description": "the netmask of the VLAN IP range", + "name": "netmask", "type": "string" }, { - "description": "the virtual network for the VLAN IP range", - "name": "forvirtualnetwork", - "type": "boolean" + "description": "the domain ID of the VLAN IP range", + "name": "domainid", + "type": "string" }, + {}, { - "description": "the end ip of the VLAN IP range", - "name": "endip", + "description": "the Pod name for the VLAN IP range", + "name": "podname", "type": "string" }, { @@ -87266,50 +88994,50 @@ "type": "string" }, { - "description": "the Pod ID for the VLAN IP range", - "name": "podid", + "description": "the description of the VLAN IP range", + "name": "description", "type": "string" }, { - "description": "the ID or VID of the VLAN.", - "name": "vlan", + "description": "the gateway of the VLAN IP range", + "name": "gateway", "type": "string" }, { - "description": "the start ipv6 of the VLAN IP range", - "name": "startipv6", + "description": "the ID of the VLAN IP range", + "name": "id", "type": "string" }, { - "description": "the netmask of the VLAN IP range", - "name": "netmask", - "type": "string" + "description": "indicates whether VLAN IP range is dedicated to system vms or not", + "name": "forsystemvms", + "type": "boolean" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the ID or VID of the VLAN.", + "name": "vlan", "type": "string" }, - {}, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" + "description": "the virtual network for the VLAN IP range", + "name": "forvirtualnetwork", + "type": "boolean" }, + {}, { - "description": "the domain ID of the VLAN IP range", - "name": "domainid", + "description": "the cidr of the VLAN IP range", + "name": "cidr", "type": "string" }, { - "description": "the description of the VLAN IP range", - "name": "description", + "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 network id of vlan range", + "name": "networkid", + "type": "string" }, { "description": "the project id of the vlan range", @@ -87317,18 +89045,18 @@ "type": "string" }, { - "description": "the network id of vlan range", - "name": "networkid", + "description": "the end ip of the VLAN IP range", + "name": "endip", "type": "string" }, { - "description": "the Pod name for the VLAN IP range", - "name": "podname", - "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 vlan range", - "name": "project", + "description": "the domain name of the VLAN IP range", + "name": "domain", "type": "string" } ] @@ -87346,13 +89074,6 @@ "required": true, "type": "uuid" }, - { - "description": "The API name or wildcard rule such as list*", - "length": 255, - "name": "rule", - "required": true, - "type": "string" - }, { "description": "The description of the role permission", "length": 255, @@ -87367,6 +89088,13 @@ "required": true, "type": "string" }, + { + "description": "The API name or wildcard rule such as list*", + "length": 255, + "name": "rule", + "required": true, + "type": "string" + }, { "description": "ID of the project role", "length": 255, @@ -87378,10 +89106,19 @@ ], "related": "", "response": [ - {}, { - "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 ID of the project role permission", + "name": "id", + "type": "string" + }, + { + "description": "the api name or wildcard rule", + "name": "rule", "type": "string" }, { @@ -87389,15 +89126,15 @@ "name": "projectrolename", "type": "string" }, - {}, { - "description": "the ID of the project", - "name": "projectid", + "description": "the description of the role permission", + "name": "description", "type": "string" }, + {}, { - "description": "the ID of the project role permission", - "name": "id", + "description": "the ID of the project role to which the role permission belongs", + "name": "projectroleid", "type": "string" }, { @@ -87406,23 +89143,14 @@ "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the permission type of the api name or wildcard rule, allow/deny", - "name": "permission", - "type": "string" - }, - { - "description": "the api name or wildcard rule", - "name": "rule", + "description": "the ID of the project", + "name": "projectid", "type": "string" }, + {}, { - "description": "the ID of the project role to which the role permission belongs", - "name": "projectroleid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" } ], @@ -87433,13 +89161,6 @@ "isasync": false, "name": "listRegisteredServicePackages", "params": [ - { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, { "description": "List by keyword", "length": 255, @@ -87453,19 +89174,25 @@ "name": "pagesize", "required": false, "type": "integer" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" } ], "related": "", "response": [ { - "description": "Description of Service Package", - "name": "description", + "description": "Service Package Name", + "name": "name", "type": "string" }, - {}, { - "description": "Service Package UUID", - "name": "id", + "description": "Description of Service Package", + "name": "description", "type": "string" }, { @@ -87473,17 +89200,18 @@ "name": "jobstatus", "type": "integer" }, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "Service Package Name", - "name": "name", + "description": "Service Package UUID", + "name": "id", "type": "string" - } + }, + {}, + {} ] }, { @@ -87491,13 +89219,6 @@ "isasync": false, "name": "updateProjectRolePermission", "params": [ - { - "description": "Rule permission, can be: allow or deny", - "length": 255, - "name": "permission", - "required": false, - "type": "string" - }, { "description": "ID of the project role", "length": 255, @@ -87507,12 +89228,19 @@ "type": "uuid" }, { - "description": "The parent role permission uuid, use 0 to move this rule at the top of the list", + "description": "Rule permission, can be: allow or deny", "length": 255, - "name": "ruleorder", + "name": "permission", + "required": false, + "type": "string" + }, + { + "description": "Project Role permission rule id", + "length": 255, + "name": "projectrolepermissionid", "related": "", "required": false, - "type": "list" + "type": "uuid" }, { "description": "ID of project where project role permission is to be updated", @@ -87523,32 +89251,32 @@ "type": "uuid" }, { - "description": "Project Role permission rule id", + "description": "The parent role permission uuid, use 0 to move this rule at the top of the list", "length": 255, - "name": "projectrolepermissionid", + "name": "ruleorder", "related": "", "required": false, - "type": "uuid" + "type": "list" } ], "response": [ + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, {}, - { - "description": "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", @@ -87570,18 +89298,18 @@ "type": "string" }, { - "description": "the ID of the virtual machine for enabling static NAT feature", + "description": "the public IP address ID for which static NAT feature is being enabled", "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", + "name": "ipaddressid", + "related": "updateIpAddress,associateIpAddress,listPublicIpAddresses", "required": true, "type": "uuid" }, { - "description": "the public IP address ID for which static NAT feature is being enabled", + "description": "the ID of the virtual machine for enabling static NAT feature", "length": 255, - "name": "ipaddressid", - "related": "updateIpAddress,associateIpAddress,listPublicIpAddresses", + "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" }, @@ -87589,56 +89317,24 @@ "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,listF5LoadBalancerNetworks,listBrocadeVcsDeviceNetworks", + "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork,listBrocadeVcsDeviceNetworks", "required": false, "type": "uuid" } ], "response": [ - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" }, {}, - {} - ] - }, - { - "description": "Deletes a Zone.", - "isasync": false, - "name": "deleteZone", - "params": [ - { - "description": "the ID of the Zone", - "length": 255, - "name": "id", - "related": "createZone,listZones", - "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", @@ -87648,107 +89344,25 @@ "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - }, - {}, - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - }, - {} - ] - }, - { - "description": "Adds user to a project", - "isasync": true, - "name": "addUserToProject", - "params": [ - { - "description": "email ID of user to which invitation to the project is going to be sent", - "length": 255, - "name": "email", - "required": false, - "type": "string" - }, - { - "description": "ID of the project to add the user to", - "length": 255, - "name": "projectid", - "related": "activateProject,suspendProject", - "required": true, - "type": "uuid" - }, - { - "description": "Project role type to be assigned to the user - Admin/Regular", - "length": 255, - "name": "roletype", - "required": false, - "type": "string" - }, - { - "description": "ID of the project role", - "length": 255, - "name": "projectroleid", - "related": "", - "required": false, - "type": "uuid" - }, - { - "description": "Name of the user to be added to the project", - "length": 255, - "name": "username", - "required": true, - "type": "string" - } - ], - "response": [ - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - {}, - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - }, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" } - ], - "since": "4.14" + ] }, { - "description": "Disables HA cluster-wide", - "isasync": true, - "name": "disableHAForCluster", + "description": "Deletes a Zone.", + "isasync": false, + "name": "deleteZone", "params": [ { - "description": "ID of the cluster", + "description": "the ID of the Zone", "length": 255, - "name": "clusterid", - "related": "addCluster", + "name": "id", + "related": "createZone,listZones", "required": true, "type": "uuid" } ], "response": [ {}, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "true if operation is executed successfully", "name": "success", @@ -87759,507 +89373,169 @@ "name": "displaytext", "type": "string" }, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - } - ], - "since": "4.11" - }, - { - "description": "Recovers a virtual machine.", - "isasync": false, - "name": "recoverVirtualMachine", - "params": [ - { - "description": "The ID of the virtual machine", - "length": 255, - "name": "id", - "related": "recoverVirtualMachine,attachIso,destroyVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,startVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance", - "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", - "response": [ - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the pool type of the virtual machine", - "name": "pooltype", - "type": "string" - }, - { - "description": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", - "response": [ - { - "description": "the project name of the affinity group", - "name": "project", - "type": "string" - }, - { - "description": "the type of the affinity group", - "name": "type", - "type": "string" - }, - { - "description": "the ID of the affinity group", - "name": "id", - "type": "string" - }, - { - "description": "the description of the affinity group", - "name": "description", - "type": "string" - }, - { - "description": "the project ID of the affinity group", - "name": "projectid", - "type": "string" - }, - { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" - }, - { - "description": "the domain name of the affinity group", - "name": "domain", - "type": "string" - }, - { - "description": "the account owning the affinity group", - "name": "account", - "type": "string" - }, - { - "description": "the name of the affinity group", - "name": "name", - "type": "string" - }, - { - "description": "the domain ID of the affinity group", - "name": "domainid", - "type": "string" - } - ], - "type": "set" - }, - { - "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": "the incoming network traffic on the vm", - "name": "networkkbsread", - "type": "long" - }, - { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", - "type": "string" - }, - { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" - }, - { - "description": "the name of the virtual machine", - "name": "name", - "type": "string" - }, - { - "description": "the outgoing network traffic on the host", - "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", - "type": "string" - }, - { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", - "type": "string" - }, - { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", - "type": "string" - }, - { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", - "type": "string" - }, - { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" - }, - { - "description": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" - }, - { - "description": "the vgpu type used by the virtual machine", - "name": "vgpu", - "type": "string" - }, - { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" - }, - { - "description": "Guest vm Boot Mode", - "name": "bootmode", - "type": "string" - }, - { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", - "type": "string" - }, - { - "description": "the list of resource tags associated", - "name": "tags", - "response": [ - { - "description": "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": "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 account associated with the tag", - "name": "account", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", - "type": "string" - }, - { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", - "type": "string" - }, - {}, - { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", - "type": "boolean" - }, - { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", - "type": "boolean" - }, - { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", - "type": "string" - }, - { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", - "type": "string" - }, - { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", + "description": "the 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": "email ID of user to which invitation to the project is going to be sent", + "length": 255, + "name": "email", + "required": false, "type": "string" }, { - "description": "the group name of the virtual machine", - "name": "group", + "description": "Name of the user to be added to the project", + "length": 255, + "name": "username", + "required": true, "type": "string" }, { - "description": "the name of the disk offering of the virtual machine", - "name": "diskofferingname", - "type": "string" + "description": "ID of the project to add the user to", + "length": 255, + "name": "projectid", + "related": "activateProject,suspendProject", + "required": true, + "type": "uuid" }, { - "description": "the number of cpu this virtual machine is running with", - "name": "cpunumber", - "type": "integer" + "description": "ID of the project role", + "length": 255, + "name": "projectroleid", + "related": "", + "required": false, + "type": "uuid" }, { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", + "description": "Project role type to be assigned to the user - Admin/Regular", + "length": 255, + "name": "roletype", + "required": false, "type": "string" - }, - {}, + } + ], + "response": [ { - "description": "the internal memory that's free in vm or zero if it can not be calculated", - "name": "memoryintfreekbs", - "type": "long" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, { - "description": "the state of the virtual machine", - "name": "state", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, + {}, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, { - "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" + } + ], + "since": "4.14" + }, + { + "description": "Disables HA cluster-wide", + "isasync": true, + "name": "disableHAForCluster", + "params": [ { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", - "type": "string" - }, + "description": "ID of the cluster", + "length": 255, + "name": "clusterid", + "related": "addCluster", + "required": true, + "type": "uuid" + } + ], + "response": [ { - "description": "the read (io) of disk on the vm", - "name": "diskioread", - "type": "long" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", + "description": "any text associated with the success or failure", + "name": "displaytext", "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": "the user's ID who deployed the virtual machine", - "name": "userid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" + } + ], + "since": "4.11" + }, + { + "description": "Recovers a virtual machine.", + "isasync": false, + "name": "recoverVirtualMachine", + "params": [ + { + "description": "The ID of the virtual machine", + "length": 255, + "name": "id", + "related": "recoverVirtualMachine,attachIso,destroyVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,startVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance", + "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", + "response": [ + { + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "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 isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "description": "the gateway of the nic", - "name": "gateway", - "type": "string" - }, - { - "description": "the name of the corresponding network", - "name": "networkname", - "type": "string" - }, - { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", - "type": "string" - }, - { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", - "type": "string" - }, - { - "description": "the traffic type of the nic", - "name": "traffictype", - "type": "string" - }, - { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", - "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": "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": "isdefault", - "type": "boolean" - }, - { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", - "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 ID of the corresponding network", - "name": "networkid", - "type": "string" - }, - { - "description": "the ID of the nic", - "name": "id", - "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": "Type of adapter if available", - "name": "adaptertype", - "type": "string" - }, - { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", - "type": "string" - }, - { - "description": "the 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 extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" - }, - { - "description": "the IPv6 address of network", - "name": "ip6address", - "type": "string" - } - ], - "type": "set" + "description": "the memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" }, { - "description": "the ID of the virtual machine", - "name": "id", + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", "type": "string" }, { - "description": "the group ID of the virtual machine", - "name": "groupid", + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", "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": "the ID of the domain in which the virtual machine exists", @@ -88267,53 +89543,59 @@ "type": "string" }, { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", + "description": "the group name of the virtual machine", + "name": "group", "type": "string" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "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", + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" + }, + { + "description": "the group ID of the virtual machine", + "name": "groupid", "type": "string" }, + {}, { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" + "description": "device type of the root volume", + "name": "rootdevicetype", + "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the project id of the vm", + "name": "projectid", + "type": "string" }, { - "description": "ssh key-pair", - "name": "keypair", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { - "description": "the write (io) of disk on the vm", - "name": "diskiowrite", - "type": "long" + "description": "ssh key-pairs", + "name": "keypairs", + "type": "string" }, { - "description": "the write (bytes) of disk on the vm", - "name": "diskkbswrite", - "type": "long" + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" }, { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", + "description": "the ID of the disk offering of the virtual machine", + "name": "diskofferingid", "type": "string" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "the state of the virtual machine", + "name": "state", "type": "string" }, { @@ -88322,42 +89604,47 @@ "type": "string" }, { - "description": "the name of the host for the virtual machine", - "name": "hostname", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "description": "OS type id of the vm", - "name": "ostypeid", + "description": "the account associated with the virtual machine", + "name": "account", "type": "string" }, { - "description": "the ID of the disk offering of the virtual machine", - "name": "diskofferingid", + "description": "the ID of the host for the virtual machine", + "name": "hostid", "type": "string" }, { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" }, { - "description": "OS name of the vm", - "name": "osdisplayname", + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" + "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", + "type": "long" }, { "description": "list of security groups associated with the virtual machine", "name": "securitygroup", "response": [ { - "description": "the name of the security group", - "name": "name", + "description": "the account owning the security group", + "name": "account", "type": "string" }, { @@ -88366,61 +89653,143 @@ "type": "integer" }, { - "description": "the list of egress rules associated with the security group", - "name": "egressrule", + "description": "the project name of the group", + "name": "project", + "type": "string" + }, + { + "description": "the description of the security group", + "name": "description", + "type": "string" + }, + { + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" + }, + { + "description": "the project id of the group", + "name": "projectid", + "type": "string" + }, + { + "description": "the ID of the security group", + "name": "id", + "type": "string" + }, + { + "description": "the domain ID of the security group", + "name": "domainid", + "type": "string" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", "response": [ { - "description": "security group name", - "name": "securitygroupname", + "description": "tag value", + "name": "value", "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 ending IP of the security group rule ", - "name": "endport", - "type": "integer" + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" }, { - "description": "the protocol of the security group rule", - "name": "protocol", + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", "type": "string" }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the list of ingress rules associated with the security group", + "name": "ingressrule", + "response": [ + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, { "description": "account owning the security group rule", "name": "account", "type": "string" }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, { "description": "the type of the ICMP message response", "name": "icmptype", "type": "integer" }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { @@ -88428,14 +89797,19 @@ "name": "resourcetype", "type": "string" }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, { "description": "the domain associated with the tag", "name": "domain", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { @@ -88449,21 +89823,21 @@ "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" } ], "type": "set" }, { - "description": "the id of the security group rule", - "name": "ruleid", + "description": "the protocol of the security group rule", + "name": "protocol", "type": "string" }, { - "description": "the code for the ICMP message response", - "name": "icmpcode", + "description": "the starting IP of the security group rule", + "name": "startport", "type": "integer" }, { @@ -88475,16 +89849,36 @@ "type": "set" }, { - "description": "the list of ingress rules associated with the security group", - "name": "ingressrule", + "description": "the list of egress rules associated with the security group", + "name": "egressrule", "response": [ + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "tag key name", - "name": "key", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { @@ -88493,33 +89887,33 @@ "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { @@ -88528,8 +89922,8 @@ "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" } ], @@ -88550,159 +89944,493 @@ "name": "cidr", "type": "string" }, - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, { "description": "the type of the ICMP message response", "name": "icmptype", "type": "integer" }, - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "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" } ], "type": "set" }, { - "description": "the project name of the group", + "description": "the name of the security group", + "name": "name", + "type": "string" + }, + { + "description": "the domain name of the security group", + "name": "domain", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" + }, + { + "description": "the pool type of the virtual machine", + "name": "pooltype", + "type": "string" + }, + { + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" + }, + { + "description": "Guest vm Boot Type", + "name": "boottype", + "type": "string" + }, + { + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", + "type": "string" + }, + { + "description": "State of the Service from LB rule", + "name": "servicestate", + "type": "string" + }, + { + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", + "type": "string" + }, + { + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", + "type": "string" + }, + { + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" + }, + { + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the project 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": "the project name where tag belongs to", "name": "project", "type": "string" }, { - "description": "the description of the security group", + "description": "resource type", + "name": "resourcetype", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", + "type": "string" + }, + { + "description": "the name of the disk offering of the virtual machine", + "name": "diskofferingname", + "type": "string" + }, + { + "description": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" + }, + { + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", + "type": "string" + }, + { + "description": "the user's ID who deployed the virtual machine", + "name": "userid", + "type": "string" + }, + { + "description": "OS name of the vm", + "name": "osdisplayname", + "type": "string" + }, + { + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", + "type": "string" + }, + { + "description": "the 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": "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": " 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": "Guest vm Boot Mode", + "name": "bootmode", + "type": "string" + }, + { + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" + }, + { + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" + }, + { + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", + "type": "string" + }, + { + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" + }, + { + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", + "type": "string" + }, + { + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" + }, + { + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", + "response": [ + { + "description": "the account owning the affinity group", + "name": "account", + "type": "string" + }, + { + "description": "the type of the affinity group", + "name": "type", + "type": "string" + }, + { + "description": "the name of the affinity group", + "name": "name", + "type": "string" + }, + { + "description": "the description of the affinity group", "name": "description", "type": "string" }, { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - } - ], - "type": "set" + "description": "the project ID of the affinity group", + "name": "projectid", + "type": "string" + }, + { + "description": "the domain ID of the affinity group", + "name": "domainid", + "type": "string" + }, + { + "description": "the project name of the affinity group", + "name": "project", + "type": "string" + }, + { + "description": "the domain name of the affinity group", + "name": "domain", + "type": "string" + }, + { + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" + }, + { + "description": "the ID of the affinity group", + "name": "id", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the user's name who deployed the virtual machine", + "name": "username", + "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the list of nics associated with vm", + "name": "nic", + "response": [ + { + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", + "type": "string" + }, + { + "description": "the isolation uri of the nic", + "name": "isolationuri", + "type": "string" + }, + { + "description": "the IPv6 address of network", + "name": "ip6address", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" + }, + { + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "the netmask of the nic", + "name": "netmask", + "type": "string" + }, + { + "description": "the name of the corresponding network", + "name": "networkname", + "type": "string" + }, + { + "description": "the traffic type of the nic", + "name": "traffictype", + "type": "string" + }, + { + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "the gateway of the nic", + "name": "gateway", + "type": "string" + }, + { + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", + "type": "string" + }, + { + "description": "the ID of the corresponding network", + "name": "networkid", + "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 security group", + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", + "type": "string" + }, + { + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "true if nic is default, false otherwise", + "name": "macaddress", + "type": "string" + }, + { + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" + }, + { + "description": "the ID of the nic", "name": "id", "type": "string" }, { - "description": "the account owning the security group", - "name": "account", + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", "type": "string" }, { - "description": "the domain ID of the security group", - "name": "domainid", + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", "type": "string" }, { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" + "description": "the type of the nic", + "name": "type", + "type": "string" }, { - "description": "the project id of the group", - "name": "projectid", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "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": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", "type": "string" } ], "type": "set" }, { - "description": "State of the Service from LB rule", - "name": "servicestate", + "description": "the ID of the virtual machine", + "name": "id", "type": "string" }, { - "description": "the memory used by the vm", - "name": "memorykbs", + "description": "the ID of the availablility zone for the virtual machine", + "name": "zoneid", + "type": "string" + }, + { + "description": "the name of the host for the virtual machine", + "name": "hostname", + "type": "string" + }, + { + "description": "OS type id of the vm", + "name": "ostypeid", + "type": "string" + }, + { + "description": "the read (IO) of disk on the VM", + "name": "diskioread", "type": "long" }, - {}, { - "description": "the target memory in vm", - "name": "memorytargetkbs", + "description": "device ID of the root volume", + "name": "rootdeviceid", "type": "long" }, { - "description": "the speed of each cpu", - "name": "cpuspeed", - "type": "integer" + "description": "the name of the virtual machine", + "name": "name", + "type": "string" }, { "description": "the project name of the vm", @@ -88710,29 +90438,39 @@ "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": "device type of the root volume", - "name": "rootdevicetype", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the account associated with the virtual machine", - "name": "account", + "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": "Os type ID of the virtual machine", + "name": "guestosid", "type": "string" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "the read (bytes) of disk on the vm", - "name": "diskkbsread", - "type": "long" + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", + "type": "string" } ] }, @@ -88742,62 +90480,56 @@ "name": "getUploadParamsForTemplate", "params": [ { - "description": "the name of the volume/template", + "description": "32 or 64 bits support. 64 by default", "length": 255, - "name": "name", - "required": true, - "type": "string" + "name": "bits", + "required": false, + "type": "integer" }, { - "description": "true if the template supports the password reset feature; default is false", + "description": "the ID of the OS Type that best represents the OS of this template. Not required for VMware as the guest OS is obtained from the OVF file.", "length": 255, - "name": "passwordenabled", + "name": "ostypeid", + "related": "", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "true if the template is available to all accounts; default is true", + "description": "true if the template supports the password reset feature; default is false", "length": 255, - "name": "ispublic", + "name": "passwordenabled", "required": false, "type": "boolean" }, { - "description": "the target hypervisor for the template", - "length": 255, - "name": "hypervisor", - "required": true, - "type": "string" - }, - { - "description": "32 or 64 bits support. 64 by default", + "description": "the tag for this template.", "length": 255, - "name": "bits", + "name": "templatetag", "required": false, - "type": "integer" + "type": "string" }, { - "description": "the ID of the OS Type that best represents the OS of this template. Not required for VMware as the guest OS is obtained from the OVF file.", + "description": "Upload volume/template for the project", "length": 255, - "name": "ostypeid", - "related": "", + "name": "projectid", + "related": "activateProject,suspendProject", "required": false, "type": "uuid" }, { - "description": "the ID of the zone the volume/template is to be hosted on", + "description": "the format for the volume/template. Possible values include QCOW2, OVA, and VHD.", "length": 255, - "name": "zoneid", - "related": "createZone,listZones", + "name": "format", "required": true, - "type": "uuid" + "type": "string" }, { - "description": "the display text of the template. This is usually used for display purposes.", - "length": 4096, - "name": "displaytext", - "required": true, - "type": "string" + "description": "an optional domainId. If the account parameter is used, domainId must also be used.", + "length": 255, + "name": "domainid", + "related": "listDomainChildren,listDomains", + "required": false, + "type": "uuid" }, { "description": "Template details in key/value pairs.", @@ -88807,141 +90539,187 @@ "type": "map" }, { - "description": "true if this template requires HVM", + "description": "true if the template type is routing i.e., if template is used to deploy router", "length": 255, - "name": "requireshvm", + "name": "isrouting", "required": false, "type": "boolean" }, { - "description": "the tag for this template.", + "description": "an optional accountName. Must be used with domainId.", "length": 255, - "name": "templatetag", + "name": "account", "required": false, "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": "true if this template is a featured template, false otherwise", "length": 255, - "name": "checksum", + "name": "isfeatured", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "Upload volume/template for the project", + "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": "boolean" + }, + { + "description": "the name of the volume/template", + "length": 255, + "name": "name", + "required": true, + "type": "string" + }, + { + "description": "the ID of the zone the volume/template is to be hosted on", + "length": 255, + "name": "zoneid", + "related": "createZone,listZones", + "required": true, "type": "uuid" }, { - "description": "true if the template supports the sshkey upload feature; default is false", + "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", "length": 255, - "name": "sshkeyenabled", + "name": "isdynamicallyscalable", "required": false, "type": "boolean" }, { - "description": "true if the template or its derivatives are extractable; default is false", + "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": "isextractable", + "name": "checksum", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "the format for the volume/template. Possible values include QCOW2, OVA, and VHD.", + "description": "the target hypervisor for the template", "length": 255, - "name": "format", + "name": "hypervisor", "required": true, "type": "string" }, { - "description": "an optional accountName. Must be used with domainId.", - "length": 255, - "name": "account", - "required": false, + "description": "the display text of the template. This is usually used for display purposes.", + "length": 4096, + "name": "displaytext", + "required": true, "type": "string" }, { - "description": "(VMware only) true if VM deployments should preserve all the configurations defined for this template", + "description": "true if the template or its derivatives are extractable; default is false", "length": 255, - "name": "deployasis", + "name": "isextractable", "required": false, - "since": "4.15.1", "type": "boolean" }, { - "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", + "description": "(VMware only) true if VM deployments should preserve all the configurations defined for this template", "length": 255, - "name": "isdynamicallyscalable", + "name": "deployasis", "required": false, + "since": "4.15.1", "type": "boolean" }, { - "description": "true if the template type is routing i.e., if template is used to deploy router", + "description": "true if this template requires HVM", "length": 255, - "name": "isrouting", + "name": "requireshvm", "required": false, "type": "boolean" }, { - "description": "true if this template is a featured template, false otherwise", + "description": "true if the template supports the sshkey upload feature; default is false", "length": 255, - "name": "isfeatured", + "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" } ], "related": "getUploadParamsForIso", "response": [ { - "description": "the timestamp after which the signature expires", - "name": "expires", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "signature to be sent in the POST request.", - "name": "signature", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + { + "description": "POST url to upload the file to", + "name": "postURL", + "type": "url" + }, + { + "description": "the template/volume ID", + "name": "id", + "type": "uuid" + }, { "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", + "description": "the timestamp after which the signature expires", + "name": "expires", "type": "string" }, + {}, { - "description": "the template/volume ID", - "name": "id", - "type": "uuid" + "description": "signature to be sent in the POST request.", + "name": "signature", + "type": "string" }, + {} + ], + "since": "4.6.0" + }, + { + "description": "Resets network permissions.", + "isasync": false, + "name": "resetNetworkPermissions", + "params": [ + { + "description": "the network ID", + "length": 255, + "name": "networkid", + "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork,listBrocadeVcsDeviceNetworks", + "required": true, + "type": "uuid" + } + ], + "response": [ { "description": "the 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": "POST url to upload the file to", - "name": "postURL", - "type": "url" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" } ], - "since": "4.6.0" + "since": "4.17.0" }, { "description": "Release the dedication for host", @@ -88952,29 +90730,29 @@ "description": "the ID of the host", "length": 255, "name": "hostid", - "related": "cancelHostAsDegraded,reconnectHost,addBaremetalHost", + "related": "addBaremetalHost,cancelHostAsDegraded,reconnectHost", "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", @@ -89027,25 +90805,25 @@ ], "response": [ { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" }, + {}, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - {}, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" } ], @@ -89067,30 +90845,14 @@ ], "related": "", "response": [ - {}, - { - "description": "name of the disk volume", - "name": "volumename", - "type": "string" - }, - { - "description": "physical size of backedup snapshot on image store", - "name": "physicalsize", - "type": "long" - }, - { - "description": "the state of the snapshot. BackedUp means that snapshot is ready to be used; Creating - the snapshot is being allocated on the primary storage; BackingUp - the snapshot is being backed up on secondary storage", - "name": "state", - "type": "state" - }, { - "description": "id of the os on volume", - "name": "ostypeid", + "description": "display name of the os on volume", + "name": "osdisplayname", "type": "string" }, { - "description": "ID of the snapshot", - "name": "id", + "description": "the account associated with the snapshot", + "name": "account", "type": "string" }, { @@ -89099,14 +90861,19 @@ "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": "indicates whether the underlying storage supports reverting the volume to this snapshot", - "name": "revertable", - "type": "boolean" + "description": "the domain ID of the snapshot's account", + "name": "domainid", + "type": "string" + }, + { + "description": "ID of the disk volume", + "name": "volumeid", + "type": "string" }, { "description": "valid location types are primary and secondary.", @@ -89114,70 +90881,71 @@ "type": "string" }, { - "description": "valid types are hourly, daily, weekly, monthy, template, and none.", - "name": "intervaltype", + "description": "ID of the snapshot", + "name": "id", "type": "string" }, + {}, { - "description": "the domain ID of the snapshot's account", - "name": "domainid", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "virtual size of backedup snapshot on image store", - "name": "virtualsize", - "type": "long" + "description": "name of the snapshot", + "name": "name", + "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "valid types are hourly, daily, weekly, monthy, template, and none.", + "name": "intervaltype", + "type": "string" }, - {}, { "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": "id of the os on volume", + "name": "ostypeid", "type": "string" }, { - "description": "id of the availability zone", - "name": "zoneid", + "description": "the domain name of the snapshot's account", + "name": "domain", "type": "string" }, { - "description": "the account associated with the snapshot", - "name": "account", + "description": "name of the disk volume", + "name": "volumename", "type": "string" }, { - "description": "name of the snapshot", - "name": "name", + "description": "the type of the snapshot", + "name": "snapshottype", "type": "string" }, { - "description": "ID of the disk volume", - "name": "volumeid", - "type": "string" + "description": "virtual size of backedup snapshot on image store", + "name": "virtualsize", + "type": "long" }, { - "description": "display name of the os on volume", - "name": "osdisplayname", - "type": "string" + "description": "physical size of backedup snapshot on image store", + "name": "physicalsize", + "type": "long" }, { - "description": "the domain name of the snapshot's account", - "name": "domain", + "description": "id of the availability zone", + "name": "zoneid", "type": "string" }, + {}, { - "description": " the date the snapshot was created", - "name": "created", - "type": "date" + "description": "the state of the snapshot. BackedUp means that snapshot is ready to be used; Creating - the snapshot is being allocated on the primary storage; BackingUp - the snapshot is being backed up on secondary storage", + "name": "state", + "type": "state" }, { "description": "the list of resource tags associated", @@ -89189,13 +90957,13 @@ "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { @@ -89204,18 +90972,18 @@ "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { @@ -89224,8 +90992,8 @@ "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { @@ -89237,10 +91005,20 @@ "type": "set" }, { - "description": "the type of the snapshot", - "name": "snapshottype", + "description": "indicates whether the underlying storage supports reverting the volume to this snapshot", + "name": "revertable", + "type": "boolean" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + { + "description": " the date the snapshot was created", + "name": "created", + "type": "date" + }, { "description": "the project name of the snapshot", "name": "project", @@ -89253,6 +91031,13 @@ "isasync": false, "name": "listRegions", "params": [ + { + "description": "List Region by region ID.", + "length": 255, + "name": "id", + "required": false, + "type": "integer" + }, { "description": "List by keyword", "length": 255, @@ -89263,14 +91048,14 @@ { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, { - "description": "List Region by region ID.", + "description": "", "length": 255, - "name": "id", + "name": "page", "required": false, "type": "integer" }, @@ -89280,53 +91065,46 @@ "name": "name", "required": false, "type": "string" - }, - { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" } ], "related": "addRegion", "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 UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, { "description": "the ID of the region", "name": "id", "type": "integer" }, - { - "description": "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 end point of the region", "name": "endpoint", "type": "string" }, { - "description": "true if security groups support is enabled, false otherwise", - "name": "portableipserviceenabled", + "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" } ] }, @@ -89335,6 +91113,14 @@ "isasync": true, "name": "migrateSystemVm", "params": [ + { + "description": "destination Host ID to migrate VM to", + "length": 255, + "name": "hostid", + "related": "addBaremetalHost,cancelHostAsDegraded,reconnectHost", + "required": false, + "type": "uuid" + }, { "description": "Destination storage pool ID to migrate VM volumes to. Required for migrating the root disk volume", "length": 255, @@ -89352,14 +91138,6 @@ "required": true, "type": "uuid" }, - { - "description": "destination Host ID to migrate VM to", - "length": 255, - "name": "hostid", - "related": "cancelHostAsDegraded,reconnectHost,addBaremetalHost", - "required": false, - "type": "uuid" - }, { "description": "Automatically select a destination host which do not require storage migration, if hostId and storageId are not specified. false by default", "length": 255, @@ -89371,25 +91149,29 @@ ], "related": "", "response": [ + { + "description": "the Zone name for the system VM", + "name": "zonename", + "type": "string" + }, { "description": "the job ID associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job.", "name": "jobid", "type": "string" }, { - "description": "the date and time the system VM was created", - "name": "created", - "type": "date" + "description": "the gateway for the system VM", + "name": "gateway", + "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the name of the system VM", + "name": "name", "type": "string" }, - {}, { - "description": "the first DNS for the system VM", - "name": "dns1", + "description": "the Pod ID for the system VM", + "name": "podid", "type": "string" }, { @@ -89398,18 +91180,8 @@ "type": "string" }, { - "description": "the Pod name for the system VM", - "name": "podname", - "type": "string" - }, - { - "description": "public vlan range", - "name": "publicvlan", - "type": "list" - }, - { - "description": "the public MAC address for the system VM", - "name": "publicmacaddress", + "description": "the systemvm agent version", + "name": "version", "type": "string" }, { @@ -89418,8 +91190,8 @@ "type": "string" }, { - "description": "the gateway for the system VM", - "name": "gateway", + "description": "the system VM type", + "name": "systemvmtype", "type": "string" }, { @@ -89428,24 +91200,30 @@ "type": "string" }, { - "description": "the system VM type", - "name": "systemvmtype", + "description": "the second DNS for the system VM", + "name": "dns2", "type": "string" }, { - "description": "the host ID for the system VM", - "name": "hostid", + "description": "the network domain for the system VM", + "name": "networkdomain", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the private netmask for the system VM", + "name": "privatenetmask", + "type": "string" }, + {}, { - "description": "the number of active console sessions for the console proxy system vm", - "name": "activeviewersessions", - "type": "integer" + "description": "the public IP address for the system VM", + "name": "publicip", + "type": "string" + }, + { + "description": "the link local MAC address for the system vm", + "name": "linklocalmacaddress", + "type": "string" }, { "description": "the ID of the system VM", @@ -89453,8 +91231,24 @@ "type": "string" }, { - "description": "the link local netmask for the system vm", - "name": "linklocalnetmask", + "description": "the Zone ID for the system VM", + "name": "zoneid", + "type": "string" + }, + {}, + { + "description": "the Pod name for the system VM", + "name": "podname", + "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", "type": "string" }, { @@ -89462,25 +91256,24 @@ "name": "templatename", "type": "string" }, - {}, { - "description": "the hostname for the system VM", - "name": "hostname", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the last disconnected date of host", - "name": "disconnected", - "type": "date" + "description": "the first DNS for the system VM", + "name": "dns1", + "type": "string" }, { - "description": "the Zone ID for the system VM", - "name": "zoneid", - "type": "string" + "description": "public vlan range", + "name": "publicvlan", + "type": "list" }, { - "description": "the systemvm agent version", - "name": "version", + "description": "the hostname for the system VM", + "name": "hostname", "type": "string" }, { @@ -89489,38 +91282,38 @@ "type": "integer" }, { - "description": "the public IP address for the system VM", - "name": "publicip", + "description": "the host ID for the system VM", + "name": "hostid", "type": "string" }, { - "description": "the public netmask for the system VM", - "name": "publicnetmask", - "type": "string" + "description": "the last disconnected date of host", + "name": "disconnected", + "type": "date" }, { - "description": "the agent state of the system VM", - "name": "agentstate", + "description": "the public netmask for the system VM", + "name": "publicnetmask", "type": "string" }, { - "description": "the private netmask for the system VM", - "name": "privatenetmask", + "description": "guest vlan range", + "name": "guestvlan", "type": "string" }, { - "description": "the link local MAC address for the system vm", - "name": "linklocalmacaddress", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the Pod ID for the system VM", - "name": "podid", - "type": "string" + "description": "the number of active console sessions for the console proxy system vm", + "name": "activeviewersessions", + "type": "integer" }, { - "description": "the network domain for the system VM", - "name": "networkdomain", + "description": "the agent state of the system VM", + "name": "agentstate", "type": "string" }, { @@ -89529,43 +91322,28 @@ "type": "string" }, { - "description": "the state of the system VM", - "name": "state", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the date and time the system VM 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 second DNS for the system VM", - "name": "dns2", - "type": "string" - }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the Zone name for the system VM", - "name": "zonename", - "type": "string" - }, - { - "description": "guest vlan range", - "name": "guestvlan", + "description": "the link local netmask for the system vm", + "name": "linklocalnetmask", "type": "string" }, { - "description": "the name of the system VM", - "name": "name", + "description": "the state of the system VM", + "name": "state", "type": "string" } ] @@ -89590,56 +91368,50 @@ "type": "string" }, { - "description": "", + "description": "ID of the Counter.", "length": 255, - "name": "pagesize", + "name": "id", + "related": "createCounter,listCounters", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, { - "description": "ID of the Counter.", + "description": "List by keyword", "length": 255, - "name": "id", - "related": "createCounter,listCounters", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" } ], "related": "createCounter", "response": [ { - "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", + "description": "Source of the counter.", + "name": "source", "type": "string" }, - {}, { "description": "the id of the Counter", "name": "id", "type": "string" }, { - "description": "Name of the counter.", - "name": "name", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -89648,15 +91420,21 @@ "type": "string" }, { - "description": "Source of the counter.", - "name": "source", + "description": "Value in case of snmp or other specific counters.", + "name": "value", "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": "Name of the counter.", + "name": "name", "type": "string" }, + {}, {} ] }, @@ -89683,13 +91461,6 @@ ], "related": "", "response": [ - {}, - {}, - { - "description": "the physical network service provider id of the element", - "name": "nspid", - "type": "string" - }, { "description": "the id of the internal load balancer element", "name": "id", @@ -89701,15 +91472,22 @@ "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", + "type": "string" }, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" - } + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {} ], "since": "4.2.0" }, @@ -89719,18 +91497,11 @@ "name": "listVirtualRouterElements", "params": [ { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, - { - "description": "", + "description": "List by keyword", "length": 255, - "name": "pagesize", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { "description": "list virtual router elements by network service provider id", @@ -89740,13 +91511,6 @@ "required": false, "type": "uuid" }, - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - }, { "description": "list network offerings by enabled state", "length": 255, @@ -89761,42 +91525,55 @@ "related": "listVirtualRouterElements", "required": false, "type": "uuid" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" } ], "related": "", "response": [ + { + "description": "the physical network service provider id of the provider", + "name": "nspid", + "type": "string" + }, { "description": "the project id of the ipaddress", "name": "projectid", "type": "string" }, - {}, - {}, { "description": "the domain associated with the provider", "name": "domain", "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": "Enabled/Disabled the service provider", "name": "enabled", "type": "boolean" }, + {}, { "description": "the domain ID associated with the provider", "name": "domainid", "type": "string" }, + { + "description": "the id of the router", + "name": "id", + "type": "string" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", @@ -89807,14 +91584,15 @@ "name": "project", "type": "string" }, + {}, { - "description": "the id of the router", - "name": "id", + "description": "the account associated with the provider", + "name": "account", "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" } ] @@ -89847,23 +91625,23 @@ "name": "success", "type": "boolean" }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - {}, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" - } + }, + {}, + {} ] }, { @@ -89872,9 +91650,9 @@ "name": "listTrafficTypeImplementors", "params": [ { - "description": "Optional. The network traffic type, if specified, return its implementor. Otherwise, return all traffic types with their implementor", + "description": "List by keyword", "length": 255, - "name": "traffictype", + "name": "keyword", "required": false, "type": "string" }, @@ -89886,38 +91664,38 @@ "type": "integer" }, { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { - "description": "", + "description": "Optional. The network traffic type, if specified, return its implementor. Otherwise, return all traffic types with their implementor", "length": 255, - "name": "page", + "name": "traffictype", "required": false, - "type": "integer" + "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": "implementor of network traffic type", "name": "traffictypeimplementor", "type": "string" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { "description": "network traffic type", @@ -89933,26 +91711,26 @@ "name": "linkAccountToLdap", "params": [ { - "description": "The id of the domain that is to contain the linked account.", + "description": "name of the group or OU in LDAP", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", + "name": "ldapdomain", "required": true, - "type": "uuid" + "type": "string" }, { - "description": "Type of the account to auto import. Specify 0 for user and 2 for domain admin", + "description": "name of the account, it will be created if it does not exist", "length": 255, - "name": "accounttype", + "name": "account", "required": true, - "type": "short" + "type": "string" }, { - "description": "name of the group or OU in LDAP", + "description": "The id of the domain that is to contain the linked account.", "length": 255, - "name": "ldapdomain", + "name": "domainid", + "related": "listDomainChildren,listDomains", "required": true, - "type": "string" + "type": "uuid" }, { "description": "type of the ldap name. GROUP or OU, defaults to GROUP", @@ -89961,19 +91739,19 @@ "required": false, "type": "string" }, - { - "description": "name of the account, it will be created if it does not exist", - "length": 255, - "name": "account", - "required": true, - "type": "string" - }, { "description": "domain admin username in LDAP ", "length": 255, "name": "admin", "required": false, "type": "string" + }, + { + "description": "Type of the account to auto import. Specify 0 for user and 2 for domain admin", + "length": 255, + "name": "accounttype", + "required": true, + "type": "integer" } ], "related": "", @@ -89986,18 +91764,18 @@ {}, { "description": "name of the group or OU in LDAP which is linked to the domain", - "name": "name", + "name": "ldapdomain", "type": "string" }, {}, { - "description": "Type of the account to auto import", - "name": "accounttype", - "type": "short" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "name of the group or OU in LDAP which is linked to the domain", - "name": "ldapdomain", + "name": "name", "type": "string" }, { @@ -90005,23 +91783,95 @@ "name": "type", "type": "string" }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, { "description": "id of the Domain which is linked to LDAP", "name": "domainid", "type": "string" }, + { + "description": "Type of the account to auto import", + "name": "accounttype", + "type": "int" + } + ], + "since": "4.11.0" + }, + { + "description": "list the db hosts and statistics", + "isasync": false, + "name": "listDbMetrics", + "params": [], + "related": "", + "response": [ + { + "description": "the name of the active usage server", + "name": "hostname", + "type": "string" + }, + { + "description": "the state of the usage server", + "name": "replicas", + "type": "string[]" + }, + {}, + { + "description": "the last measured load averages on the DB", + "name": "dbloadaverages", + "type": "double[]" + }, + { + "description": "the time these statistics were collected", + "name": "collectiontime", + "type": "date" + }, + { + "description": "the uptime of the DB in seconds", + "name": "uptime", + "type": "int" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" + }, + { + "description": "the version of the currently running DB", + "name": "versioncomment", + "type": "string" + }, + { + "description": "the number of queries performed on the DB", + "name": "queries", + "type": "int" + }, + { + "description": "the number of connections to the DB", + "name": "connections", + "type": "int" + }, + { + "description": "the version of the currently running DB", + "name": "version", + "type": "string" + }, + { + "description": "the tls versions currently in use (accepted) by the DB", + "name": "tlsversions", + "type": "string" } ], - "since": "4.11.0" + "since": "4.17.0" }, { "description": "Deletes an image store or Secondary Storage.", @@ -90038,28 +91888,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": "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.2.0" }, @@ -90069,75 +91919,66 @@ "name": "listAutoScaleVmProfiles", "params": [ { - "description": "the otherdeployparameters of the autoscale vm profile", - "length": 255, - "name": "otherdeployparams", - "required": false, - "type": "string" - }, - { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "fordisplay", + "name": "listall", "required": false, - "since": "4.4", "type": "boolean" }, { - "description": "the ID of the autoscale vm profile", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "id", - "related": "createAutoScaleVmProfile,listAutoScaleVmProfiles", + "name": "domainid", + "related": "listDomainChildren,listDomains", "required": false, "type": "uuid" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false", + "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", "length": 255, - "name": "listall", + "name": "fordisplay", "required": false, + "since": "4.4", "type": "boolean" }, { - "description": "", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "pagesize", + "name": "projectid", + "related": "activateProject,suspendProject", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "the templateid of the autoscale vm profile", + "description": "the ID of the autoscale vm profile", "length": 255, - "name": "templateid", - "related": "registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", + "name": "id", + "related": "createAutoScaleVmProfile,listAutoScaleVmProfiles", "required": false, "type": "uuid" }, { - "description": "list objects by project", + "description": "availability zone for the auto deployed virtual machine", "length": 255, - "name": "projectid", - "related": "activateProject,suspendProject", + "name": "zoneid", + "related": "createZone,listZones", "required": false, + "since": "4.4", "type": "uuid" }, { - "description": "list profiles by service offering id", + "description": "List by keyword", "length": 255, - "name": "serviceofferingid", - "related": "updateServiceOffering,listServiceOfferings", + "name": "keyword", "required": false, - "since": "4.4", - "type": "uuid" + "type": "string" }, { - "description": "availability zone for the auto deployed virtual machine", + "description": "the otherdeployparameters of the autoscale vm profile", "length": 255, - "name": "zoneid", - "related": "createZone,listZones", + "name": "otherdeployparams", "required": false, - "since": "4.4", - "type": "uuid" + "type": "string" }, { "description": "list resources by account. Must be used with the domainId parameter.", @@ -90149,16 +91990,17 @@ { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, { - "description": "List by keyword", + "description": "the templateid of the autoscale vm profile", "length": 255, - "name": "keyword", + "name": "templateid", + "related": "registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", "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.", @@ -90168,52 +92010,63 @@ "type": "boolean" }, { - "description": "list only resources belonging to the domain specified", + "description": "list profiles by service offering id", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", + "name": "serviceofferingid", + "related": "updateServiceOffering,listServiceOfferings", "required": false, + "since": "4.4", "type": "uuid" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" } ], "related": "createAutoScaleVmProfile", "response": [ { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the domain ID of the vm profile", + "name": "domainid", "type": "string" }, {}, { - "description": "is profile for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "the project id vm profile", + "name": "projectid", + "type": "string" }, { - "description": "the time allowed for existing connections to get closed before a vm is destroyed", - "name": "destroyvmgraceperiod", - "type": "integer" + "description": "the ID of the user used to launch and destroy the VMs", + "name": "autoscaleuserid", + "type": "string" }, { - "description": "the service offering to be used while deploying a virtual machine", - "name": "serviceofferingid", - "type": "string" + "description": "is profile for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, { - "description": "the project id vm profile", - "name": "projectid", + "description": "the project name of the vm profile", + "name": "project", "type": "string" }, - {}, - {}, { - "description": "the domain name of the vm profile", - "name": "domain", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the availability zone to be used while deploying a virtual machine", - "name": "zoneid", + "description": "the service offering to be used while deploying a virtual machine", + "name": "serviceofferingid", "type": "string" }, { @@ -90221,26 +92074,21 @@ "name": "otherdeployparams", "type": "string" }, - { - "description": "the project name of the vm profile", - "name": "project", - "type": "string" - }, - {}, { "description": "the template to be used while deploying a virtual machine", "name": "templateid", "type": "string" }, { - "description": "the ID of the user used to launch and destroy the VMs", - "name": "autoscaleuserid", + "description": "the availability zone to be used while deploying a virtual machine", + "name": "zoneid", "type": "string" }, + {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the domain name of the vm profile", + "name": "domain", + "type": "string" }, { "description": "the autoscale vm profile ID", @@ -90248,15 +92096,17 @@ "type": "string" }, { - "description": "the domain ID of the vm profile", - "name": "domainid", - "type": "string" + "description": "the time allowed for existing connections to get closed before a vm is destroyed", + "name": "destroyvmgraceperiod", + "type": "integer" }, { "description": "the account owning the instance group", "name": "account", "type": "string" - } + }, + {}, + {} ] }, { @@ -90268,13 +92118,14 @@ "description": "the ID of the host", "length": 255, "name": "hostid", - "related": "cancelHostAsDegraded,reconnectHost,addBaremetalHost", + "related": "addBaremetalHost,cancelHostAsDegraded,reconnectHost", "required": true, "type": "uuid" } ], "related": "enableOutOfBandManagementForHost,disableOutOfBandManagementForCluster", "response": [ + {}, { "description": "the out-of-band management interface powerState of the host", "name": "powerstate", @@ -90286,9 +92137,9 @@ "type": "string" }, { - "description": "the ID of the host", - "name": "hostid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "the out-of-band management action (if issued)", @@ -90296,23 +92147,13 @@ "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 out-of-band management interface port", - "name": "port", + "description": "the out-of-band management interface username", + "name": "username", "type": "string" }, { - "description": "the out-of-band management interface address", - "name": "address", + "description": "the operation result description", + "name": "description", "type": "string" }, { @@ -90322,26 +92163,35 @@ }, {}, { - "description": "the out-of-band management interface username", - "name": "username", - "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 operation result", - "name": "status", - "type": "boolean" + "description": "the out-of-band management interface password", + "name": "password", + "type": "string" }, { - "description": "the operation result description", - "name": "description", + "description": "the out-of-band management interface address", + "name": "address", "type": "string" }, - {} + { + "description": "the out-of-band management interface port", + "name": "port", + "type": "string" + }, + { + "description": "the ID of the host", + "name": "hostid", + "type": "string" + } ], "since": "4.9.0" }, @@ -90354,108 +92204,107 @@ "description": "host ID", "length": 255, "name": "id", - "related": "cancelHostAsDegraded,reconnectHost,addBaremetalHost", + "related": "addBaremetalHost,cancelHostAsDegraded,reconnectHost", "required": true, "type": "uuid" } ], - "related": "reconnectHost,addBaremetalHost", + "related": "addBaremetalHost,reconnectHost", "response": [ - { - "description": "the amount of the host's memory currently allocated in percentage", - "name": "memoryallocatedpercentage", - "type": "string" - }, - { - "description": "the CPU speed of the host", - "name": "cpuspeed", - "type": "long" - }, { "description": "true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise", "name": "hasenoughcapacity", "type": "boolean" }, { - "description": "the cpu average load on the host", - "name": "cpuloadaverage", - "type": "double" + "description": "the cluster name of the host", + "name": "clustername", + "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 cluster ID of the host", - "name": "clusterid", - "type": "string" + "description": "the amount of the host's CPU currently allocated in MHz", + "name": "cpuallocatedvalue", + "type": "long" }, { - "description": "the resource state of the host", - "name": "resourcestate", - "type": "string" + "description": "the date and time the host was removed", + "name": "removed", + "type": "date" }, { - "description": "events available for the host", - "name": "events", - "type": "string" + "description": "the host type", + "name": "type", + "type": "type" }, { - "description": "the management server ID of the host", - "name": "managementserverid", + "description": "the amount of the host's CPU currently allocated in percentage", + "name": "cpuallocatedpercentage", "type": "string" }, { - "description": "the host out-of-band management information", - "name": "outofbandmanagement", - "type": "outofbandmanagementresponse" + "description": "the host's currently allocated disk size", + "name": "disksizeallocated", + "type": "long" }, { - "description": "the cluster type of the cluster that host belongs to", - "name": "clustertype", + "description": "the amount of the host's CPU currently used", + "name": "cpuused", "type": "string" }, { - "description": "true if the host is disconnected. False otherwise.", - "name": "disconnected", + "description": "the last time this host was annotated", + "name": "lastannotated", "type": "date" }, - {}, { - "description": "the amount of the host's memory currently allocated in bytes", - "name": "memoryallocatedbytes", + "description": "the amount of the host's memory currently used", + "name": "memoryused", "type": "long" }, { - "description": "the state of the host", - "name": "state", - "type": "status" + "description": "comma-separated list of tags for the host", + "name": "hosttags", + "type": "string" }, { - "description": "the amount of the host's memory after applying the mem.overprovisioning.factor", - "name": "memorywithoverprovisioning", + "description": "the amount of the host's CPU currently allocated", + "name": "cpuallocated", "type": "string" }, { - "description": "the number of CPU sockets on the host", - "name": "cpusockets", - "type": "integer" + "description": "the host hypervisor", + "name": "hypervisor", + "type": "hypervisortype" }, { - "description": "the hypervisor version", - "name": "hypervisorversion", - "type": "string" + "description": "the amount of the host's memory currently allocated in bytes", + "name": "memoryallocatedbytes", + "type": "long" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "the CPU number of the host", + "name": "cpunumber", + "type": "integer" + }, + { + "description": "true if the host has capability to support UEFI boot", + "name": "ueficapability", "type": "boolean" }, { - "description": "the Pod name of the host", - "name": "podname", - "type": "string" + "description": "the outgoing network traffic on the host", + "name": "networkkbswrite", + "type": "long" + }, + { + "description": "the host out-of-band management information", + "name": "outofbandmanagement", + "type": "outofbandmanagementresponse" }, { "description": "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", @@ -90463,74 +92312,64 @@ "type": "boolean" }, { - "description": "the last annotation set on this host by an admin", - "name": "annotation", - "type": "string" - }, - { - "description": "the cluster name of the host", - "name": "clustername", + "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": "true if the host is disconnected. False otherwise.", + "name": "disconnected", + "type": "date" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the management server ID of the host", + "name": "managementserverid", "type": "string" }, { - "description": "the total disk size of the host", - "name": "disksizetotal", + "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", + "name": "memorytotal", "type": "long" }, - {}, - { - "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise", - "name": "hahost", - "type": "boolean" - }, { - "description": "the OS category ID of the host", - "name": "oscategoryid", + "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", + "name": "cpuallocatedwithoverprovisioning", "type": "string" }, { - "description": "comma-separated list of tags for the host", - "name": "hosttags", - "type": "string" + "description": "the date and time the host was last pinged", + "name": "lastpinged", + "type": "date" }, + {}, { - "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", - "name": "memorytotal", - "type": "long" + "description": "Host details in key/value pairs.", + "name": "details", + "type": "map" }, { - "description": "the amount of the host's CPU currently allocated in MHz", - "name": "cpuallocatedvalue", + "description": "the incoming network traffic on the host", + "name": "networkkbsread", "type": "long" }, { - "description": "the host version", - "name": "version", - "type": "string" + "description": "the state of the host", + "name": "state", + "type": "status" }, { - "description": "the name of the host", - "name": "name", - "type": "string" + "description": "the number of CPU sockets on the host", + "name": "cpusockets", + "type": "integer" }, { - "description": "the OS category name of the host", - "name": "oscategoryname", + "description": "the Zone name of the host", + "name": "zonename", "type": "string" }, { - "description": "capabilities of the host", - "name": "capabilities", + "description": "the Pod ID of the host", + "name": "podid", "type": "string" }, { @@ -90538,60 +92377,46 @@ "name": "id", "type": "string" }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + {}, { "description": "the date and time the host was created", "name": "created", "type": "date" }, { - "description": "the outgoing network traffic on the host", - "name": "networkkbswrite", - "type": "long" - }, - { - "description": "true if the host has capability to support UEFI boot", - "name": "ueficapability", + "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": "the host type", - "name": "type", - "type": "type" - }, - { - "description": "the amount of the host's memory currently allocated", - "name": "memoryallocated", - "type": "long" - }, - { - "description": "the amount of the host's memory currently used", - "name": "memoryused", - "type": "long" + "description": "the cpu average load on the host", + "name": "cpuloadaverage", + "type": "double" }, { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", - "type": "long" + "description": "the hypervisor version", + "name": "hypervisorversion", + "type": "string" }, { - "description": "the amount of the host's CPU currently used", - "name": "cpuused", + "description": "the last annotation set on this host by an admin", + "name": "annotation", "type": "string" }, { - "description": "the amount of the host's CPU currently allocated in percentage", - "name": "cpuallocatedpercentage", + "description": "the amount of the host's memory currently allocated in percentage", + "name": "memoryallocatedpercentage", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the Pod name of the host", + "name": "podname", + "type": "string" }, { "description": "GPU cards present in the host", @@ -90607,13 +92432,13 @@ "name": "vgpu", "response": [ { - "description": "Maximum vgpu can be created with this vgpu type on the given gpu group", - "name": "maxcapacity", + "description": "Maximum displays per user", + "name": "maxheads", "type": "long" }, { - "description": "Maximum Y resolution per display", - "name": "maxresolutiony", + "description": "Maximum vgpu can be created with this vgpu type on the given gpu group", + "name": "maxcapacity", "type": "long" }, { @@ -90622,8 +92447,8 @@ "type": "string" }, { - "description": "Maximum displays per user", - "name": "maxheads", + "description": "Video RAM for this vGPU type", + "name": "videoram", "type": "long" }, { @@ -90632,18 +92457,18 @@ "type": "long" }, { - "description": "Maximum no. of vgpu per gpu card (pgpu)", - "name": "maxvgpuperpgpu", + "description": "Maximum Y resolution per display", + "name": "maxresolutiony", "type": "long" }, { - "description": "Video RAM for this vGPU type", - "name": "videoram", + "description": "Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type", + "name": "remainingcapacity", "type": "long" }, { - "description": "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" } ], @@ -90653,9 +92478,24 @@ "type": "list" }, { - "description": "the date and time the host was removed", - "name": "removed", - "type": "date" + "description": "the IP address of the host", + "name": "ipaddress", + "type": "string" + }, + { + "description": "events available for the host", + "name": "events", + "type": "string" + }, + { + "description": "the amount of the host's memory after applying the mem.overprovisioning.factor", + "name": "memorywithoverprovisioning", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor", @@ -90663,9 +92503,24 @@ "type": "string" }, { - "description": "the last time this host was annotated", - "name": "lastannotated", - "type": "date" + "description": "the resource state of the host", + "name": "resourcestate", + "type": "string" + }, + { + "description": "the admin that annotated this host", + "name": "username", + "type": "string" + }, + { + "description": "the cluster ID of the host", + "name": "clusterid", + "type": "string" + }, + { + "description": "the name of the host", + "name": "name", + "type": "string" }, { "description": "the host HA information information", @@ -90673,54 +92528,49 @@ "type": "hostharesponse" }, { - "description": "the incoming network traffic on the host", - "name": "networkkbsread", - "type": "long" - }, - { - "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", - "name": "cpuallocatedwithoverprovisioning", + "description": "capabilities of the host", + "name": "capabilities", "type": "string" }, { - "description": "the IP address of the host", - "name": "ipaddress", - "type": "string" + "description": "the amount of the host's memory currently allocated", + "name": "memoryallocated", + "type": "long" }, { - "description": "the Pod ID of the host", - "name": "podid", + "description": "the OS category ID of the host", + "name": "oscategoryid", "type": "string" }, { - "description": "the date and time the host was last pinged", - "name": "lastpinged", - "type": "date" + "description": "the CPU speed of the host", + "name": "cpuspeed", + "type": "long" }, { - "description": "the Zone name of the host", - "name": "zonename", + "description": "the host version", + "name": "version", "type": "string" }, { - "description": "the amount of the host's CPU currently allocated", - "name": "cpuallocated", - "type": "string" + "description": "the total disk size of the host", + "name": "disksizetotal", + "type": "long" }, { - "description": "the admin that annotated this host", - "name": "username", + "description": "the OS category name of the host", + "name": "oscategoryname", "type": "string" }, { - "description": "Host details in key/value pairs.", - "name": "details", - "type": "map" + "description": "the cluster type of the cluster that host belongs to", + "name": "clustertype", + "type": "string" }, { - "description": "the Zone ID of the host", - "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" } ], "since": "4.16.0.0" @@ -90731,48 +92581,48 @@ "name": "authorizeSecurityGroupIngress", "params": [ { - "description": "the protocol for the ACL rule. Valid values are TCP/UDP/ICMP/ALL or valid protocol number (see /etc/protocols). ALL is default.", + "description": "an optional domainId for the security group. If the account parameter is used, domainId must also be used.", "length": 255, - "name": "protocol", + "name": "domainid", + "related": "listDomainChildren,listDomains", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "end port for this ingress rule", + "description": "error code for this icmp message", "length": 255, - "name": "endport", + "name": "icmpcode", "required": false, "type": "integer" }, { - "description": "the cidr list associated. Multiple entries must be separated by a single comma character (,).", + "description": "The ID of the security group. Mutually exclusive with securityGroupName parameter", "length": 255, - "name": "cidrlist", + "name": "securitygroupid", + "related": "createSecurityGroup", "required": false, - "type": "list" + "type": "uuid" }, { - "description": "an optional domainId for the security group. If the account parameter is used, domainId must also be used.", + "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": "domainid", - "related": "listDomainChildren,listDomains", + "name": "protocol", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "start port for this ingress rule", + "description": "The name of the security group. Mutually exclusive with securityGroupId parameter", "length": 255, - "name": "startport", + "name": "securitygroupname", "required": false, - "type": "integer" + "type": "string" }, { - "description": "The ID of the security group. Mutually exclusive with securityGroupName parameter", + "description": "start port for this ingress rule", "length": 255, - "name": "securitygroupid", - "related": "createSecurityGroup", + "name": "startport", "required": false, - "type": "uuid" + "type": "integer" }, { "description": "user to security group mapping", @@ -90782,12 +92632,18 @@ "type": "map" }, { - "description": "an optional project of the security group", + "description": "end port for this ingress rule", "length": 255, - "name": "projectid", - "related": "activateProject,suspendProject", + "name": "endport", "required": false, - "type": "uuid" + "type": "integer" + }, + { + "description": "the cidr list associated. Multiple entries must be separated by a single comma character (,).", + "length": 255, + "name": "cidrlist", + "required": false, + "type": "list" }, { "description": "type of the icmp message being sent", @@ -90804,18 +92660,12 @@ "type": "string" }, { - "description": "The name of the security group. Mutually exclusive with securityGroupId parameter", - "length": 255, - "name": "securitygroupname", - "required": false, - "type": "string" - }, - { - "description": "error code for this icmp message", + "description": "an optional project of the security group", "length": 255, - "name": "icmpcode", + "name": "projectid", + "related": "activateProject,suspendProject", "required": false, - "type": "integer" + "type": "uuid" } ], "related": "", @@ -90825,23 +92675,38 @@ "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 account associated with the tag", - "name": "account", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "tag value", + "name": "value", "type": "string" }, { @@ -90850,23 +92715,23 @@ "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { @@ -90882,56 +92747,41 @@ ], "type": "set" }, - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, {}, { "description": "the code for the ICMP message response", "name": "icmpcode", "type": "integer" }, + { + "description": "the 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 starting IP of the security group rule", + "name": "startport", + "type": "integer" }, { "description": "account owning the security group rule", "name": "account", "type": "string" }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "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", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" } ] @@ -90953,13 +92803,34 @@ "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance", "response": [ { - "description": "total min IOPS currently in use by volumes", - "name": "allocatediops", - "type": "long" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the hypervisor type of the storage pool", - "name": "hypervisor", + "description": "the state of the storage pool", + "name": "state", + "type": "storagepoolstatus" + }, + { + "description": "the storage pool type", + "name": "type", + "type": "string" + }, + {}, + { + "description": "true if this pool is suitable to migrate a volume, false otherwise", + "name": "suitableformigration", + "type": "boolean" + }, + { + "description": "the IP address of the storage pool", + "name": "ipaddress", + "type": "string" + }, + { + "description": "Storage provider for this pool", + "name": "provider", "type": "string" }, { @@ -90967,19 +92838,29 @@ "name": "path", "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 date and time the storage pool was created", "name": "created", "type": "date" }, { - "description": "IOPS CloudStack can provision from this storage pool", - "name": "capacityiops", - "type": "long" + "description": "the scope of the storage pool", + "name": "scope", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the name of the storage pool", + "name": "name", "type": "string" }, { @@ -90988,19 +92869,28 @@ "type": "long" }, { - "description": "the host's currently used disk size", - "name": "disksizeused", - "type": "long" + "description": "the ID of the cluster for the storage pool", + "name": "clusterid", + "type": "string" }, { "description": "the overprovisionfactor for the storage pool", "name": "overprovisionfactor", "type": "string" }, - {}, { - "description": "the Zone name of the storage pool", - "name": "zonename", + "description": "the name of the cluster for the storage pool", + "name": "clustername", + "type": "string" + }, + { + "description": "the host's currently used disk size", + "name": "disksizeused", + "type": "long" + }, + { + "description": "the Zone ID of the storage pool", + "name": "zoneid", "type": "string" }, { @@ -91009,8 +92899,8 @@ "type": "string" }, { - "description": "the storage pool type", - "name": "type", + "description": "the Zone name of the storage pool", + "name": "zonename", "type": "string" }, { @@ -91018,82 +92908,42 @@ "name": "disksizetotal", "type": "long" }, - { - "description": "the storage pool capabilities", - "name": "storagecapabilities", - "type": "map" - }, { "description": "the Pod ID of the storage pool", "name": "podid", "type": "string" }, - { - "description": "true if this pool is suitable to migrate a volume, false otherwise", - "name": "suitableformigration", - "type": "boolean" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the Pod name of the storage pool", - "name": "podname", - "type": "string" - }, - { - "description": "the Zone ID of the storage pool", - "name": "zoneid", - "type": "string" - }, - {}, - { - "description": "Storage provider for this pool", - "name": "provider", - "type": "string" - }, { "description": "the ID of the storage pool", "name": "id", "type": "string" }, { - "description": "the ID of the cluster for the storage pool", - "name": "clusterid", - "type": "string" - }, - { - "description": "the name of the storage pool", - "name": "name", + "description": "the hypervisor type of the storage pool", + "name": "hypervisor", "type": "string" }, { - "description": "the state of the storage pool", - "name": "state", - "type": "storagepoolstatus" + "description": "the storage pool capabilities", + "name": "storagecapabilities", + "type": "map" }, { - "description": "the name of the cluster for the storage pool", - "name": "clustername", + "description": "the Pod name of the storage pool", + "name": "podname", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "IOPS CloudStack can provision from this storage pool", + "name": "capacityiops", + "type": "long" }, { - "description": "the IP address of the storage pool", - "name": "ipaddress", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - { - "description": "the scope of the storage pool", - "name": "scope", - "type": "string" - } + {} ], "since": "4.15.1" }, @@ -91110,10 +92960,10 @@ "type": "string" }, { - "description": "name of the security group", + "description": "the description of the security group", "length": 255, - "name": "name", - "required": true, + "name": "description", + "required": false, "type": "string" }, { @@ -91125,10 +92975,10 @@ "type": "uuid" }, { - "description": "the description of the security group", + "description": "name of the security group", "length": 255, - "name": "description", - "required": false, + "name": "name", + "required": true, "type": "string" }, { @@ -91143,18 +92993,13 @@ "related": "", "response": [ { - "description": "the ID of the security group", - "name": "id", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the name of the security group", + "name": "name", "type": "string" }, { - "description": "the project id of the group", - "name": "projectid", + "description": "the ID of the security group", + "name": "id", "type": "string" }, { @@ -91162,47 +93007,48 @@ "name": "project", "type": "string" }, + {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", "type": "integer" }, { - "description": "the name of the security group", - "name": "name", - "type": "string" - }, - { - "description": "the list of ingress rules associated with the security group", - "name": "ingressrule", + "description": "the list of egress rules associated with the security group", + "name": "egressrule", "response": [ { - "description": "the id of the security group rule", - "name": "ruleid", + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "account owning the security group rule", + "name": "account", "type": "string" }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, { "description": "tag value", "name": "value", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "tag key name", + "name": "key", "type": "string" }, { @@ -91216,8 +93062,8 @@ "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { @@ -91226,152 +93072,93 @@ "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", "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 type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, { "description": "security group name", "name": "securitygroupname", "type": "string" }, { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, - { - "description": "account owning the security group rule", - "name": "account", - "type": "string" - }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - } - ], - "type": "set" - }, - { - "description": "the domain ID of the security group", - "name": "domainid", - "type": "string" - }, - {}, - {}, - { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "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", + "description": "the id of the security group rule", + "name": "ruleid", "type": "string" }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "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": "resource type", - "name": "resourcetype", - "type": "string" + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" } ], "type": "set" }, { - "description": "the description of the security group", - "name": "description", + "description": "the domain ID of the security group", + "name": "domainid", "type": "string" }, { - "description": "the list of egress rules associated with the security group", - "name": "egressrule", + "description": "the list of ingress rules associated with the security group", + "name": "ingressrule", "response": [ { - "description": "the protocol of the security group rule", - "name": "protocol", + "description": "the id of the security group rule", + "name": "ruleid", "type": "string" }, { - "description": "security group name", - "name": "securitygroupname", + "description": "account owning the security group rule", + "name": "account", "type": "string" }, { - "description": "account owning the security group rule", - "name": "account", + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "security group name", + "name": "securitygroupname", "type": "string" }, { @@ -91379,33 +93166,33 @@ "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": "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": "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": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { @@ -91414,59 +93201,122 @@ "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 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" } ], "type": "set" }, { - "description": "the id of the security group rule", - "name": "ruleid", + "description": "the protocol of the security group rule", + "name": "protocol", "type": "string" }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, { "description": "the starting IP of the security group rule", "name": "startport", "type": "integer" + } + ], + "type": "set" + }, + { + "description": "the project id of the group", + "name": "projectid", + "type": "string" + }, + { + "description": "the domain name of the security group", + "name": "domain", + "type": "string" + }, + {}, + { + "description": "the account owning the security group", + "name": "account", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" }, { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" }, { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "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": "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": "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": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" } ], "type": "set" }, { - "description": "the account owning the security group", - "name": "account", + "description": "the description of the security group", + "name": "description", "type": "string" }, { @@ -91475,58 +93325,77 @@ "type": "set" }, { - "description": "the domain name of the security group", - "name": "domain", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ] }, { - "description": "Removes a VM from any existing backup offering", - "isasync": true, - "name": "removeVirtualMachineFromBackupOffering", + "description": "List network visibility and all accounts that have permissions to view this network.", + "isasync": false, + "name": "listNetworkPermissions", "params": [ { - "description": "ID of the virtual machine", + "description": "Lists network permission by network ID", "length": 255, - "name": "virtualmachineid", - "related": "attachIso,destroyVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,startVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,importUnmanagedInstance", + "name": "networkid", + "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork,listBrocadeVcsDeviceNetworks", "required": true, "type": "uuid" - }, - { - "description": "Whether to force remove VM from the backup offering that may also delete VM backups.", - "length": 255, - "name": "forced", - "required": false, - "type": "boolean" } ], + "related": "", "response": [ - {}, + { + "description": "the network ID", + "name": "networkid", + "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 account the network is available for", + "name": "account", "type": "string" }, {}, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "the ID of account the network is available for", + "name": "accountid", + "type": "string" + }, + { + "description": "the ID of project the network is available for", + "name": "projectid", + "type": "string" + }, + { + "description": "the name of the domain to which the network belongs", + "name": "domain", + "type": "string" }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" + }, + { + "description": "the ID of the domain to which the network belongs", + "name": "domainid", + "type": "string" + }, + { + "description": "the project the network is available for", + "name": "project", + "type": "string" } ], - "since": "4.14.0" + "since": "4.17.0" }, { "description": "Recalculate and update resource count for an account or domain.", @@ -91541,6 +93410,13 @@ "required": false, "type": "uuid" }, + { + "description": "Update resource count for a specified account. Must be used with the domainId parameter.", + "length": 255, + "name": "account", + "required": false, + "type": "string" + }, { "description": "If account parameter specified then updates resource counts for a specified account in this domain else update resource counts for all accounts & child domains in specified domain.", "length": 255, @@ -91555,25 +93431,13 @@ "name": "resourcetype", "required": false, "type": "integer" - }, - { - "description": "Update resource count for a specified account. Must be used with the domainId parameter.", - "length": 255, - "name": "account", - "required": false, - "type": "string" } ], "related": "", "response": [ { - "description": "the domain name for which resource count's are updated", - "name": "domain", - "type": "string" - }, - { - "description": "resource type. Values include 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11. See the resourceType parameter for more information on these values.", - "name": "resourcetype", + "description": "the account for which resource count's are updated", + "name": "account", "type": "string" }, { @@ -91581,16 +93445,22 @@ "name": "jobid", "type": "string" }, + { + "description": "resource count", + "name": "resourcecount", + "type": "long" + }, { "description": "the project name for which resource count's are updated", "name": "project", "type": "string" }, { - "description": "the project id for which resource count's are updated", - "name": "projectid", + "description": "the domain name for which resource count's are updated", + "name": "domain", "type": "string" }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", @@ -91601,21 +93471,20 @@ "name": "resourcetypename", "type": "string" }, + {}, { - "description": "resource count", - "name": "resourcecount", - "type": "long" + "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 domain ID for which resource count's are updated", - "name": "domainid", + "description": "the project id for which resource count's are updated", + "name": "projectid", "type": "string" }, - {}, - {}, { - "description": "the account for which resource count's are updated", - "name": "account", + "description": "the domain ID for which resource count's are updated", + "name": "domainid", "type": "string" } ] @@ -91626,49 +93495,34 @@ "name": "listVpnGateways", "params": [ { - "description": "list only resources belonging to the domain specified", + "description": "id of vpc", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", + "name": "vpcid", + "related": "createVPC,listVPCs,updateVPC", "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", - "length": 255, - "name": "listall", - "required": false, - "type": "boolean" - }, - { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "List by keyword", "length": 255, - "name": "account", + "name": "keyword", "required": false, "type": "string" }, { - "description": "list objects by project", + "description": "id of the vpn gateway", "length": 255, - "name": "projectid", - "related": "activateProject,suspendProject", + "name": "id", + "related": "createVpnGateway,listVpnGateways", "required": false, "type": "uuid" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - }, - { - "description": "id of vpc", + "description": "", "length": 255, - "name": "vpcid", - "related": "createVPC,listVPCs,updateVPC", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" }, { "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", @@ -91679,10 +93533,17 @@ "type": "boolean" }, { - "description": "id of the vpn gateway", + "description": "", "length": 255, - "name": "id", - "related": "createVpnGateway,listVpnGateways", + "name": "page", + "required": false, + "type": "integer" + }, + { + "description": "list objects by project; if projectid=-1 lists All VMs", + "length": 255, + "name": "projectid", + "related": "activateProject,suspendProject", "required": false, "type": "uuid" }, @@ -91694,52 +93555,43 @@ "type": "boolean" }, { - "description": "", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "page", + "name": "listall", "required": false, - "type": "integer" + "type": "boolean" }, { - "description": "", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "pagesize", + "name": "domainid", + "related": "listDomainChildren,listDomains", "required": false, - "type": "integer" + "type": "uuid" + }, + { + "description": "list resources by account. Must be used with the domainId parameter.", + "length": 255, + "name": "account", + "required": false, + "type": "string" } ], "related": "createVpnGateway", "response": [ { - "description": "the date and time the host was removed", - "name": "removed", - "type": "date" - }, - { - "description": "the vpn gateway ID", - "name": "id", - "type": "string" - }, - { - "description": "the project name", - "name": "project", + "description": "the domain name of the owner", + "name": "domain", "type": "string" }, - {}, { - "description": "the domain id of the owner", - "name": "domainid", + "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 domain name of the owner", - "name": "domain", + "description": "the project id", + "name": "projectid", "type": "string" }, { @@ -91747,10 +93599,12 @@ "name": "vpcid", "type": "string" }, + {}, + {}, { - "description": "the project id", - "name": "projectid", - "type": "string" + "description": "the date and time the host was removed", + "name": "removed", + "type": "date" }, { "description": "the vpc name of this gateway", @@ -91758,9 +93612,9 @@ "type": "string" }, { - "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": "is vpn gateway for display to the regular user", @@ -91768,14 +93622,29 @@ "type": "boolean" }, { - "description": "the public IP address", - "name": "publicip", + "description": "the owner", + "name": "account", + "type": "string" + }, + { + "description": "the project name", + "name": "project", + "type": "string" + }, + { + "description": "the domain id of the owner", + "name": "domainid", "type": "string" }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" + }, + { + "description": "the vpn gateway ID", + "name": "id", + "type": "string" } ] }, @@ -91785,66 +93654,54 @@ "name": "listRoles", "params": [ { - "description": "List role by role ID.", + "description": "List role by role name.", "length": 255, - "name": "id", - "related": "importRole,listRoles", + "name": "name", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "List role by role name.", + "description": "List by keyword", "length": 255, - "name": "name", + "name": "keyword", "required": false, "type": "string" }, { - "description": "", + "description": "List role by role type, valid options are: Admin, ResourceAdmin, DomainAdmin, User.", "length": 255, - "name": "pagesize", + "name": "type", "required": false, - "type": "integer" + "type": "string" }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, { - "description": "List role by role type, valid options are: Admin, ResourceAdmin, DomainAdmin, User.", + "description": "List role by role ID.", "length": 255, - "name": "type", + "name": "id", + "related": "importRole,listRoles", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "page", "required": false, - "type": "string" + "type": "integer" } ], "related": "importRole", "response": [ { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - {}, - { - "description": "the name of the role", - "name": "name", - "type": "string" - }, - {}, - { - "description": "the description of the role", - "name": "description", + "description": "the type of the role", + "name": "type", "type": "string" }, { @@ -91852,20 +93709,32 @@ "name": "jobid", "type": "string" }, + {}, { - "description": "the type of the role", - "name": "type", + "description": "the ID of the role", + "name": "id", "type": "string" }, { - "description": "the ID of the role", - "name": "id", + "description": "the name of the role", + "name": "name", "type": "string" }, + {}, { "description": "true if role is default, false otherwise", "name": "isdefault", "type": "boolean" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the description of the role", + "name": "description", + "type": "string" } ], "since": "4.9.0" @@ -91886,31 +93755,31 @@ ], "related": "", "response": [ - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the cloud identifier", + "name": "cloudidentifier", + "type": "string" }, { - "description": "the user ID for the cloud identifier", - "name": "userid", + "description": "the signed response for the cloud identifier", + "name": "signature", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the user ID for the cloud identifier", + "name": "userid", "type": "string" }, {}, { - "description": "the signed response for the cloud identifier", - "name": "signature", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, { - "description": "the cloud identifier", - "name": "cloudidentifier", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" } ] @@ -91921,18 +93790,11 @@ "name": "createLBStickinessPolicy", "params": [ { - "description": "name of the load balancer stickiness policy method, possible values can be obtained from listNetworks API", - "length": 255, - "name": "methodname", - "required": true, - "type": "string" - }, - { - "description": "param list. Example: param[0].name=cookiename¶m[0].value=LBCookie ", - "length": 255, - "name": "param", - "required": false, - "type": "map" + "description": "name of the load balancer stickiness policy", + "length": 255, + "name": "name", + "required": true, + "type": "string" }, { "description": "an optional field, whether to the display the rule to the end user or not", @@ -91949,24 +93811,42 @@ "required": false, "type": "string" }, + { + "description": "name of the load balancer stickiness policy method, possible values can be obtained from listNetworks API", + "length": 255, + "name": "methodname", + "required": true, + "type": "string" + }, { "description": "the ID of the load balancer rule", "length": 255, "name": "lbruleid", - "related": "", + "related": "updateIpv6FirewallRule", "required": true, "type": "uuid" }, { - "description": "name of the load balancer stickiness policy", + "description": "param list. Example: param[0].name=cookiename¶m[0].value=LBCookie ", "length": 255, - "name": "name", - "required": true, - "type": "string" + "name": "param", + "required": false, + "type": "map" } ], "related": "listLBStickinessPolicies", "response": [ + { + "description": "the LB rule ID", + "name": "lbruleid", + "type": "string" + }, + { + "description": "the state of the policy", + "name": "state", + "type": "string" + }, + {}, { "description": "the domain of the Stickiness policy", "name": "domain", @@ -91977,11 +93857,7 @@ "name": "zoneid", "type": "string" }, - { - "description": "the state of the policy", - "name": "state", - "type": "string" - }, + {}, { "description": "the description of the Stickiness policy", "name": "description", @@ -91992,29 +93868,24 @@ "name": "name", "type": "string" }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, { "description": "the list of stickinesspolicies", "name": "stickinesspolicy", "response": [ { - "description": "the params of the policy", - "name": "params", - "type": "map" + "description": "is policy for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, { - "description": "the description of the Stickiness policy", - "name": "description", + "description": "the method name of the Stickiness policy", + "name": "methodname", "type": "string" }, { - "description": "the state of the policy", - "name": "state", - "type": "string" + "description": "the params of the policy", + "name": "params", + "type": "map" }, { "description": "the name of the Stickiness policy", @@ -92022,43 +93893,41 @@ "type": "string" }, { - "description": "the LB Stickiness policy ID", - "name": "id", + "description": "the description of the Stickiness policy", + "name": "description", "type": "string" }, { - "description": "the method name of the Stickiness policy", - "name": "methodname", + "description": "the LB Stickiness policy ID", + "name": "id", "type": "string" }, { - "description": "is policy for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "the state of the policy", + "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 domain ID of the Stickiness policy", - "name": "domainid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {}, { "description": "the account of the Stickiness policy", "name": "account", "type": "string" }, - {}, { - "description": "the LB rule ID", - "name": "lbruleid", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the domain ID of the Stickiness policy", + "name": "domainid", "type": "string" } ], @@ -92070,40 +93939,38 @@ "name": "addCiscoAsa1000vResource", "params": [ { - "description": "the Physical Network ID", + "description": "the Cluster ID", "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork", + "name": "clusterid", + "related": "addCluster", "required": true, "type": "uuid" }, { - "description": "Hostname or ip address of the Cisco ASA 1000v appliance.", + "description": "Nexus port profile associated with inside interface of ASA 1000v", "length": 255, - "name": "hostname", + "name": "insideportprofile", "required": true, "type": "string" }, { - "description": "the Cluster ID", + "description": "the Physical Network ID", "length": 255, - "name": "clusterid", - "related": "addCluster", + "name": "physicalnetworkid", + "related": "createPhysicalNetwork", "required": true, "type": "uuid" }, { - "description": "Nexus port profile associated with inside interface of ASA 1000v", + "description": "Hostname or ip address of the Cisco ASA 1000v appliance.", "length": 255, - "name": "insideportprofile", + "name": "hostname", "required": true, "type": "string" } ], "related": "", "response": [ - {}, - {}, {}, {}, { @@ -92111,13 +93978,15 @@ "name": "jobstatus", "type": "integer" }, - {}, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, + {}, + {}, + {}, + {}, {} ] }, @@ -92150,90 +94019,90 @@ "type": "integer" }, { - "description": "the username that's used to log in to the external firewall", - "name": "username", + "description": "the management IP address of the external firewall", + "name": "ipaddress", "type": "string" }, { - "description": "the usage interface of the external firewall", - "name": "usageinterface", + "description": "device capacity", + "name": "fwdevicecapacity", + "type": "long" + }, + { + "description": "the public security zone of the external firewall", + "name": "publiczone", "type": "string" }, { - "description": "device state", - "name": "fwdevicestate", + "description": "the public interface of the external firewall", + "name": "publicinterface", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the private security zone of the external firewall", + "name": "privatezone", "type": "string" }, { - "description": "the public security zone of the external firewall", - "name": "publiczone", + "description": "the username that's used to log in to the external firewall", + "name": "username", "type": "string" }, + {}, { - "description": "name of the provider", - "name": "provider", + "description": "the timeout (in seconds) for requests to the external firewall", + "name": "timeout", "type": "string" }, + {}, { "description": "the physical network to which this Palo Alto firewall belongs to", "name": "physicalnetworkid", "type": "string" }, { - "description": "the public interface of the external firewall", - "name": "publicinterface", + "description": "device id of the Palo Alto firewall", + "name": "fwdeviceid", "type": "string" }, { - "description": "device capacity", - "name": "fwdevicecapacity", - "type": "long" - }, - { - "description": "the management IP address of the external firewall", - "name": "ipaddress", + "description": "the number of times to retry requests to the external firewall", + "name": "numretries", "type": "string" }, { - "description": "device name", - "name": "fwdevicename", + "description": "the zone ID of the external firewall", + "name": "zoneid", "type": "string" }, { - "description": "the timeout (in seconds) for requests to the external firewall", - "name": "timeout", + "description": "device state", + "name": "fwdevicestate", "type": "string" }, { - "description": "the zone ID of the external firewall", - "name": "zoneid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the private interface of the external firewall", - "name": "privateinterface", + "description": "the usage interface of the external firewall", + "name": "usageinterface", "type": "string" }, { - "description": "the private security zone of the external firewall", - "name": "privatezone", + "description": "name of the provider", + "name": "provider", "type": "string" }, - {}, - {}, { - "description": "the number of times to retry requests to the external firewall", - "name": "numretries", + "description": "device name", + "name": "fwdevicename", "type": "string" }, { - "description": "device id of the Palo Alto firewall", - "name": "fwdeviceid", + "description": "the private interface of the external firewall", + "name": "privateinterface", "type": "string" } ] @@ -92244,26 +94113,25 @@ "name": "updateNetworkACLItem", "params": [ { - "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", + "description": "Indicates if the ACL rule is to be updated partially (merging the parameters sent with current configuration) or completely (disconsidering all of the current configurations). The default value is 'true'.", "length": 255, - "name": "customid", + "name": "partialupgrade", "required": false, - "since": "4.4", - "type": "string" + "type": "boolean" }, { - "description": "the traffic type for the ACL, can be Ingress or Egress, defaulted to Ingress if not specified", + "description": "The network of the vm the ACL will be created for", "length": 255, - "name": "traffictype", + "name": "number", "required": false, - "type": "string" + "type": "integer" }, { - "description": "the cidr list to allow traffic from/to. Multiple entries must be separated by a single comma character (,).", + "description": "the traffic type for the ACL, can be Ingress or Egress, defaulted to Ingress if not specified", "length": 255, - "name": "cidrlist", + "name": "traffictype", "required": false, - "type": "list" + "type": "string" }, { "description": "the ID of the network ACL item", @@ -92274,9 +94142,9 @@ "type": "uuid" }, { - "description": "The network of the vm the ACL will be created for", + "description": "the starting port of ACL", "length": 255, - "name": "number", + "name": "startport", "required": false, "type": "integer" }, @@ -92288,18 +94156,26 @@ "type": "string" }, { - "description": "the protocol for the ACL rule. Valid values are TCP/UDP/ICMP/ALL or valid protocol number", + "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", "length": 255, - "name": "protocol", + "name": "customid", "required": false, + "since": "4.4", "type": "string" }, { - "description": "type of the ICMP message being sent", + "description": "the cidr list to allow traffic from/to. Multiple entries must be separated by a single comma character (,).", "length": 255, - "name": "icmptype", + "name": "cidrlist", "required": false, - "type": "integer" + "type": "list" + }, + { + "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": "scl entry action, allow or deny", @@ -92317,23 +94193,16 @@ "type": "boolean" }, { - "description": "the starting port of ACL", + "description": "error code for this ICMP message", "length": 255, - "name": "startport", + "name": "icmpcode", "required": false, "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": "error code for this ICMP message", + "description": "type of the ICMP message being sent", "length": 255, - "name": "icmpcode", + "name": "icmptype", "required": false, "type": "integer" }, @@ -92354,49 +94223,43 @@ "type": "string" }, { - "description": "the protocol of the ACL", - "name": "protocol", - "type": "string" + "description": "Number of the ACL Item", + "name": "number", + "type": "integer" }, { - "description": "the ID of the ACL this item belongs to", - "name": "aclid", + "description": "Action of ACL Item. Allow/Deny", + "name": "action", "type": "string" }, { - "description": "the name of the ACL this item belongs to", - "name": "aclname", + "description": "the ID of the ACL Item", + "name": "id", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - {}, - { - "description": "is rule for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "the ID of the ACL this item belongs to", + "name": "aclid", + "type": "string" }, { - "description": "the state of the rule", - "name": "state", + "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", "type": "string" }, { - "description": "Action of ACL Item. Allow/Deny", - "name": "action", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "type of the icmp message being sent", - "name": "icmptype", - "type": "integer" + "description": "an explanation on why this ACL rule is being applied", + "name": "reason", + "type": "string" }, { - "description": "the traffic type for the ACL", - "name": "traffictype", + "description": "the state of the rule", + "name": "state", "type": "string" }, { @@ -92405,28 +94268,29 @@ "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "error code for this icmp message", + "name": "icmpcode", + "type": "integer" }, { - "description": "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": "Number of the ACL Item", - "name": "number", - "type": "integer" + "description": "the name of the ACL this item belongs to", + "name": "aclname", + "type": "string" }, + {}, { - "description": "the ID of the ACL Item", - "name": "id", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "an explanation on why this ACL rule is being applied", - "name": "reason", + "description": "the traffic type for the ACL", + "name": "traffictype", "type": "string" }, { @@ -92434,38 +94298,38 @@ "name": "tags", "response": [ { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { @@ -92474,21 +94338,26 @@ "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "id of the resource", + "name": "resourceid", "type": "string" } ], "type": "list" }, { - "description": "error code for this icmp message", - "name": "icmpcode", + "description": "the protocol of the ACL", + "name": "protocol", + "type": "string" + }, + { + "description": "type of the icmp message being sent", + "name": "icmptype", "type": "integer" } ] @@ -92498,6 +94367,14 @@ "isasync": false, "name": "moveUser", "params": [ + { + "description": "id of the user to be deleted", + "length": 255, + "name": "id", + "related": "createUser,enableUser,getUser", + "required": true, + "type": "uuid" + }, { "description": "Creates the user under the specified account. If no account is specified, the username will be used as the account name.", "length": 255, @@ -92512,38 +94389,30 @@ "related": "enableAccount,listAccounts,listAccounts", "required": false, "type": "uuid" - }, - { - "description": "id of the user to be deleted", - "length": 255, - "name": "id", - "related": "createUser,enableUser,getUser", - "required": true, - "type": "uuid" } ], "response": [ {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" + "description": "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.11" @@ -92554,11 +94423,20 @@ "name": "listRouters", "params": [ { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "if true is passed for this parameter, also fetch last executed health check results for the router. Default is false", "length": 255, - "name": "account", + "name": "fetchhealthcheckresults", "required": false, - "type": "string" + "since": "4.14", + "type": "boolean" + }, + { + "description": "list by network id", + "length": 255, + "name": "networkid", + "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork,listBrocadeVcsDeviceNetworks", + "required": false, + "type": "uuid" }, { "description": "the ID of the disk router", @@ -92569,26 +94447,25 @@ "type": "uuid" }, { - "description": "the state of the router", + "description": "List by keyword", "length": 255, - "name": "state", + "name": "keyword", "required": false, "type": "string" }, { - "description": "list by network id", + "description": "", "length": 255, - "name": "networkid", - "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork,listF5LoadBalancerNetworks,listBrocadeVcsDeviceNetworks", + "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": "the state of the router", "length": 255, - "name": "isrecursive", + "name": "state", "required": false, - "type": "boolean" + "type": "string" }, { "description": "the Pod ID of the router", @@ -92599,154 +94476,151 @@ "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", - "length": 255, - "name": "listall", - "required": false, - "type": "boolean" - }, - { - "description": "", + "description": "the cluster ID of the router", "length": 255, - "name": "pagesize", + "name": "clusterid", + "related": "addCluster", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "if true is passed for this parameter, also fetch last executed health check results for the router. Default is false", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "fetchhealthcheckresults", + "name": "projectid", + "related": "activateProject,suspendProject", "required": false, - "since": "4.14", - "type": "boolean" + "type": "uuid" }, { - "description": "", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "page", + "name": "account", "required": false, - "type": "integer" + "type": "string" }, { - "description": "list virtual router elements by version", + "description": "the host ID of the router", "length": 255, - "name": "version", + "name": "hostid", + "related": "addBaremetalHost,reconnectHost", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "the Zone ID of the router", + "description": "List networks by VPC", "length": 255, - "name": "zoneid", - "related": "createZone,listZones", + "name": "vpcid", + "related": "createVPC,listVPCs,updateVPC", "required": false, "type": "uuid" }, { - "description": "list only resources belonging to the domain specified", + "description": "list virtual router elements by version", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", + "name": "version", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "list objects by project", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "projectid", - "related": "activateProject,suspendProject", + "name": "isrecursive", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "the cluster ID of the router", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "clusterid", - "related": "addCluster", + "name": "listall", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "if this parameter is passed, list only routers by health check results", + "description": "if true is passed for this parameter, list only VPC routers", "length": 255, - "name": "healthchecksfailed", + "name": "forvpc", "required": false, - "since": "4.16", "type": "boolean" }, { - "description": "List by keyword", + "description": "the Zone ID of the router", "length": 255, - "name": "keyword", + "name": "zoneid", + "related": "createZone,listZones", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "the name of the router", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "name", + "name": "domainid", + "related": "listDomainChildren,listDomains", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "the host ID of the router", + "description": "if this parameter is passed, list only routers by health check results", "length": 255, - "name": "hostid", - "related": "reconnectHost,addBaremetalHost", + "name": "healthchecksfailed", "required": false, - "type": "uuid" + "since": "4.16", + "type": "boolean" }, { - "description": "List networks by VPC", + "description": "the name of the router", "length": 255, - "name": "vpcid", - "related": "createVPC,listVPCs,updateVPC", + "name": "name", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "if true is passed for this parameter, list only VPC routers", + "description": "", "length": 255, - "name": "forvpc", + "name": "page", "required": false, - "type": "boolean" + "type": "integer" } ], "related": "destroyRouter", "response": [ { - "description": "the link local netmask for the router", - "name": "linklocalnetmask", + "description": "VPC the router belongs to", + "name": "vpcid", "type": "string" }, { - "description": "the guest MAC address for the router", - "name": "guestmacaddress", + "description": "the host ID for the router", + "name": "hostid", "type": "string" }, { - "description": "the state of redundant virtual router", - "name": "redundantstate", + "description": "the ID of the corresponding public network", + "name": "publicnetworkid", "type": "string" }, { - "description": "the second IPv6 DNS for the router", - "name": "ip6dns2", + "description": "true if any health checks had failed", + "name": "healthchecksfailed", + "type": "boolean" + }, + { + "description": "the version of the code / software in the router", + "name": "softwareversion", "type": "string" }, { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "the version of template", + "name": "version", "type": "string" }, { - "description": "the guest IP address for the router", - "name": "guestipaddress", + "description": "the project name of the address", + "name": "project", "type": "string" }, { - "description": "the domain associated with the router", - "name": "domain", + "description": "the domain ID associated with the router", + "name": "domainid", "type": "string" }, { @@ -92754,8 +94628,13 @@ "name": "nic", "response": [ { - "description": "the netmask of the nic", - "name": "netmask", + "description": "the name of the corresponding network", + "name": "networkname", + "type": "string" + }, + { + "description": "the gateway of the nic", + "name": "gateway", "type": "string" }, { @@ -92764,13 +94643,28 @@ "type": "string" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", "type": "string" }, { - "description": "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 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 netmask of the nic", + "name": "netmask", "type": "string" }, { @@ -92779,34 +94673,34 @@ "type": "list" }, { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "the ID of the nic", + "name": "id", "type": "string" }, { - "description": "the gateway of the nic", - "name": "gateway", + "description": "true if nic is default, false otherwise", + "name": "macaddress", "type": "string" }, { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "the isolation uri of the nic", + "name": "isolationuri", "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 broadcast uri of the nic", - "name": "broadcasturi", + "description": "the IPv6 address of network", + "name": "ip6address", "type": "string" }, { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { "description": "the Secondary ipv4 addr of nic", @@ -92814,13 +94708,8 @@ "type": "list" }, { - "description": "the ID of the nic", - "name": "id", - "type": "string" - }, - { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", "type": "string" }, { @@ -92829,315 +94718,310 @@ "type": "list" }, { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "the type of the nic", + "name": "type", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", - "type": "string" + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" }, { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "the ID of the corresponding network", + "name": "networkid", "type": "string" }, { - "description": "the type of the nic", - "name": "type", + "description": "the traffic type of the nic", + "name": "traffictype", "type": "string" }, { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", "type": "string" }, { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", "type": "integer" }, { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", "type": "string" }, { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", "type": "string" }, { - "description": "the IPv6 address of network", - "name": "ip6address", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" } ], "type": "set" }, { - "description": "the name of the router", - "name": "name", + "description": "the network domain for the router", + "name": "networkdomain", "type": "string" }, { - "description": "true if any health checks had failed", - "name": "healthchecksfailed", - "type": "boolean" + "description": "the template name for the router", + "name": "templatename", + "type": "string" }, { "description": "the name of the service offering of the virtual machine", "name": "serviceofferingname", "type": "string" }, - {}, { - "description": "the public netmask for the router", - "name": "publicnetmask", + "description": "the Pod ID for the router", + "name": "podid", "type": "string" }, { - "description": "the Zone ID for the router", - "name": "zoneid", + "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 hostname for the router", + "name": "hostname", + "type": "string" }, { - "description": "the name of VPC the router belongs to", - "name": "vpcname", + "description": "the first IPv6 DNS for the router", + "name": "ip6dns1", "type": "string" }, { - "description": "if this router is an redundant virtual router", - "name": "isredundantrouter", - "type": "boolean" + "description": "the name of VPC the router belongs to", + "name": "vpcname", + "type": "string" }, { - "description": "role of the domain router", - "name": "role", + "description": "the gateway for the router", + "name": "gateway", "type": "string" }, { - "description": "the first DNS for the router", - "name": "dns1", + "description": "the link local IP address for the router", + "name": "linklocalip", "type": "string" }, { - "description": "the guest netmask for the router", - "name": "guestnetmask", + "description": "the version of scripts", + "name": "scriptsversion", "type": "string" }, + {}, { - "description": "true if the router template requires upgrader", - "name": "requiresupgrade", - "type": "boolean" + "description": "the ID of the corresponding guest network", + "name": "guestnetworkid", + "type": "string" }, { - "description": "the version of scripts", - "name": "scriptsversion", + "description": "the state of redundant virtual router", + "name": "redundantstate", "type": "string" }, + {}, { "description": "the state of the router", "name": "state", "type": "state" }, { - "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 name of the corresponding guest network", - "name": "guestnetworkname", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the first IPv6 DNS for the router", - "name": "ip6dns1", + "description": "the id of the router", + "name": "id", "type": "string" }, { - "description": "the gateway for the router", - "name": "gateway", + "description": "the Zone name for the router", + "name": "zonename", "type": "string" }, { - "description": "the template name for the router", - "name": "templatename", + "description": "the template ID for the router", + "name": "templateid", "type": "string" }, { - "description": "the ID of the corresponding guest network", - "name": "guestnetworkid", + "description": "the guest IP address for the router", + "name": "guestipaddress", "type": "string" }, { - "description": "the date and time the router was created", - "name": "created", - "type": "date" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the link local IP address for the router", - "name": "linklocalip", + "description": "the guest netmask for the router", + "name": "guestnetmask", "type": "string" }, { - "description": "the ID of the corresponding link local network", - "name": "linklocalnetworkid", + "description": "the public netmask for the router", + "name": "publicnetmask", "type": "string" }, { - "description": "the account associated with the router", - "name": "account", + "description": "the public IP address for the router", + "name": "publicip", "type": "string" }, { - "description": "the second DNS for the router", - "name": "dns2", + "description": "the first DNS for the router", + "name": "dns1", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the account associated with the router", + "name": "account", + "type": "string" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "Last executed health check result for the router", - "name": "healthcheckresults", - "response": [ - { - "description": "result of the health check", - "name": "success", - "type": "boolean" - }, - { - "description": "the type of the health check - basic or advanced", - "name": "checktype", - "type": "string" - }, - { - "description": "detailed response generated on running health check", - "name": "details", - "type": "string" - }, - { - "description": "the name of the health check on the router", - "name": "checkname", - "type": "string" - }, - { - "description": "the date this VPC was created", - "name": "lastupdated", - "type": "date" - } - ], - "type": "list" + "description": "if this router is an redundant virtual router", + "name": "isredundantrouter", + "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the project id of the ipaddress", + "name": "projectid", "type": "string" }, { - "description": "the public MAC address for the router", - "name": "publicmacaddress", + "description": "the guest MAC address for the router", + "name": "guestmacaddress", "type": "string" }, { - "description": "the hostname for the router", - "name": "hostname", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, { - "description": "VPC the router belongs to", - "name": "vpcid", + "description": "the Pod name for the router", + "name": "podname", "type": "string" }, { - "description": "the id of the router", - "name": "id", + "description": "the link local netmask for the router", + "name": "linklocalnetmask", "type": "string" }, { - "description": "the Pod name for the router", - "name": "podname", + "description": "the public MAC address for the router", + "name": "publicmacaddress", "type": "string" }, { - "description": "the network domain for the router", - "name": "networkdomain", + "description": "the name of the router", + "name": "name", "type": "string" }, { - "description": "the domain ID associated with the router", - "name": "domainid", - "type": "string" + "description": "the date and time the router was created", + "name": "created", + "type": "date" }, { - "description": "the Pod ID for the router", - "name": "podid", + "description": "the name of the corresponding guest network", + "name": "guestnetworkname", "type": "string" }, { - "description": "the version of template", - "name": "version", + "description": "the second DNS for the router", + "name": "dns2", "type": "string" }, { - "description": "the public IP address for the router", - "name": "publicip", + "description": "the domain associated with the router", + "name": "domain", "type": "string" }, { - "description": "the ID of the corresponding public network", - "name": "publicnetworkid", - "type": "string" + "description": "Last executed health check result for the router", + "name": "healthcheckresults", + "response": [ + { + "description": "result of the health check", + "name": "success", + "type": "boolean" + }, + { + "description": "detailed response generated on running health check", + "name": "details", + "type": "string" + }, + { + "description": "the date this VPC was created", + "name": "lastupdated", + "type": "date" + }, + { + "description": "the type of the health check - basic or advanced", + "name": "checktype", + "type": "string" + }, + { + "description": "the name of the health check on the router", + "name": "checkname", + "type": "string" + } + ], + "type": "list" }, { - "description": "the project name of the address", - "name": "project", + "description": "the Zone ID for the router", + "name": "zoneid", "type": "string" }, { - "description": "the template ID for the router", - "name": "templateid", + "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 ID of the corresponding link local network", + "name": "linklocalnetworkid", "type": "string" }, - {}, { - "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 link local MAC address for the router", - "name": "linklocalmacaddress", + "description": "role of the domain router", + "name": "role", "type": "string" } ] @@ -93151,34 +95035,34 @@ "description": "the host ID", "length": 255, "name": "id", - "related": "reconnectHost,addBaremetalHost", + "related": "addBaremetalHost,reconnectHost", "required": true, "type": "uuid" } ], "response": [ + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, {}, - {}, { "description": "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" - } + }, + {} ] }, { @@ -93186,14 +95070,6 @@ "isasync": true, "name": "createVpnConnection", "params": [ - { - "description": "an optional field, whether to the display the vpn to the end user or not", - "length": 255, - "name": "fordisplay", - "required": false, - "since": "4.4", - "type": "boolean" - }, { "description": "id of the customer gateway", "length": 255, @@ -93216,34 +95092,37 @@ "related": "createVpnGateway", "required": true, "type": "uuid" + }, + { + "description": "an optional field, whether to the display the vpn to the end user or not", + "length": 255, + "name": "fordisplay", + "required": false, + "since": "4.4", + "type": "boolean" } ], "related": "", "response": [ { - "description": "IPsec Preshared-Key of the customer gateway", - "name": "ipsecpsk", - "type": "string" - }, - { - "description": "the owner", - "name": "account", + "description": "public ip address id of the customer gateway", + "name": "gateway", "type": "string" }, { - "description": "if Force NAT Encapsulation is enabled for customer gateway", - "name": "forceencap", + "description": "State of vpn connection", + "name": "passive", "type": "boolean" }, { - "description": "the date and time the host was removed", - "name": "removed", - "type": "date" + "description": "IKE policy of the customer gateway", + "name": "ikepolicy", + "type": "string" }, { - "description": "guest cidr list of the customer gateway. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "is connection for display to the regular user", @@ -93251,13 +95130,18 @@ "type": "boolean" }, { - "description": "ESP policy of the customer gateway", - "name": "esppolicy", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "Lifetime of IKE SA of customer gateway", - "name": "ikelifetime", + "description": "State of vpn connection", + "name": "state", + "type": "string" + }, + { + "description": "Lifetime of ESP SA of customer gateway", + "name": "esplifetime", "type": "long" }, { @@ -93266,39 +95150,19 @@ "type": "date" }, { - "description": "the customer gateway ID", - "name": "s2scustomergatewayid", - "type": "string" - }, - { - "description": "the connection ID", - "name": "id", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "State of vpn connection", - "name": "state", + "description": "Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Defaults to ike", + "name": "ikeversion", "type": "string" }, { - "description": "if DPD is enabled for customer gateway", - "name": "dpd", - "type": "boolean" - }, - { - "description": "the vpn gateway ID", - "name": "s2svpngatewayid", + "description": "the project name", + "name": "project", "type": "string" }, { - "description": "Lifetime of ESP SA of customer gateway", - "name": "esplifetime", - "type": "long" + "description": "the date and time the host was removed", + "name": "removed", + "type": "date" }, { "description": "Split multiple remote networks into multiple phase 2 SAs. Often used with Cisco some products.", @@ -93306,56 +95170,76 @@ "type": "boolean" }, { - "description": "public ip address id of the customer gateway", - "name": "gateway", + "description": "the owner", + "name": "account", "type": "string" }, + {}, { - "description": "the project name", - "name": "project", + "description": "the customer gateway ID", + "name": "s2scustomergatewayid", "type": "string" }, { - "description": "the domain id of the owner", - "name": "domainid", + "description": "the domain name of the owner", + "name": "domain", "type": "string" }, { - "description": "the domain name of the owner", - "name": "domain", + "description": "the project id", + "name": "projectid", "type": "string" }, - {}, { - "description": "the public IP address", - "name": "publicip", + "description": "the connection ID", + "name": "id", "type": "string" }, { - "description": "State of vpn connection", - "name": "passive", + "description": "ESP policy of the customer gateway", + "name": "esppolicy", + "type": "string" + }, + { + "description": "Lifetime of IKE SA of customer gateway", + "name": "ikelifetime", + "type": "long" + }, + { + "description": "if Force NAT Encapsulation is enabled for customer gateway", + "name": "forceencap", "type": "boolean" }, {}, { - "description": "the project id", - "name": "projectid", + "description": "IPsec Preshared-Key of the customer gateway", + "name": "ipsecpsk", "type": "string" }, { - "description": "Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Defaults to ike", - "name": "ikeversion", + "description": "guest cidr list of the customer gateway. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", "type": "string" }, { - "description": "IKE policy of the customer gateway", - "name": "ikepolicy", + "description": "the vpn gateway ID", + "name": "s2svpngatewayid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the domain id of the owner", + "name": "domainid", + "type": "string" + }, + { + "description": "if DPD is enabled for customer gateway", + "name": "dpd", + "type": "boolean" + }, + { + "description": "the public IP address", + "name": "publicip", + "type": "string" } ] }, @@ -93365,19 +95249,11 @@ "name": "listBrocadeVcsDeviceNetworks", "params": [ { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "pagesize", "required": false, - "type": "string" - }, - { - "description": "brocade vcs switch ID", - "length": 255, - "name": "vcsdeviceid", - "related": "", - "required": true, - "type": "uuid" + "type": "integer" }, { "description": "", @@ -93387,14 +95263,22 @@ "type": "integer" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "pagesize", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" + }, + { + "description": "brocade vcs switch ID", + "length": 255, + "name": "vcsdeviceid", + "related": "", + "required": true, + "type": "uuid" } ], - "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork,listF5LoadBalancerNetworks", + "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork", "response": [ { "description": "The external id of the network", @@ -93402,155 +95286,103 @@ "type": "string" }, { - "description": "Name of the VPC to which this network belongs", - "name": "vpcname", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "true if users from subdomains can access the domain level network", - "name": "subdomainaccess", - "type": "boolean" + "description": "The routes for the network to ease adding route in upstream router", + "name": "ip6routes", + "type": "set" }, { - "description": "zone id of the network", - "name": "zoneid", + "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", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "the second DNS for the network", - "name": "dns2", - "type": "string" + "description": "an optional field, whether to the display the network to the end user or not.", + "name": "displaynetwork", + "type": "boolean" }, { - "description": "VPC the network belongs to", - "name": "vpcid", + "description": "the name of the zone the network belongs to", + "name": "zonename", "type": "string" }, { - "description": "acl type - access type to the network", - "name": "acltype", - "type": "string" + "description": "list networks available for vm deployment", + "name": "canusefordeploy", + "type": "boolean" }, { - "description": "the list of resource tags associated with network", - "name": "tags", - "response": [ - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "tag 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": "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 ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - } - ], - "type": "list" + "description": "broadcast uri of the network. This parameter is visible to ROOT admins only", + "name": "broadcasturi", + "type": "string" }, { - "description": "the displaytext of the network", - "name": "displaytext", + "description": "zone id of the network", + "name": "zoneid", "type": "string" }, { - "description": "true if network can span multiple zones", - "name": "strechedl2subnet", - "type": "boolean" + "description": "the date this network was created", + "name": "created", + "type": "date" }, { - "description": "network offering id the network is created from", - "name": "networkofferingid", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" + "description": "true if network supports specifying ip ranges, false otherwise", + "name": "specifyipranges", + "type": "boolean" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" + "description": "true network requires restart", + "name": "restartrequired", + "type": "boolean" }, { - "description": "availability of the network offering the network is created from", - "name": "networkofferingavailability", + "description": "the name of the Network associated with this private gateway", + "name": "associatednetwork", "type": "string" }, { - "description": "true if network is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "name of the network offering the network is created from", + "name": "networkofferingname", + "type": "string" }, { - "description": "the project name of the address", - "name": "project", + "description": "VPC the network belongs to", + "name": "vpcid", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" }, { - "description": "display text of the network offering the network is created from", - "name": "networkofferingdisplaytext", + "description": "the displaytext of the network", + "name": "displaytext", "type": "string" }, { - "description": "the network's IP range not to be used by CloudStack guest VMs and can be used for non CloudStack purposes", - "name": "reservediprange", + "description": "the traffic type of the network", + "name": "traffictype", "type": "string" }, { - "description": "ACL name associated with the VPC network", - "name": "aclname", + "description": "The internet protocol of network offering", + "name": "internetprotocol", "type": "string" }, { @@ -93558,41 +95390,34 @@ "name": "dns1", "type": "string" }, - {}, { - "description": "list networks that are persistent", - "name": "ispersistent", - "type": "boolean" + "description": "The vlan of the network. This parameter is visible to ROOT admins only", + "name": "vlan", + "type": "string" }, { - "description": "true if network supports specifying ip ranges, false otherwise", - "name": "specifyipranges", + "description": "If the network has redundant routers enabled", + "name": "redundantrouter", "type": "boolean" }, - {}, - { - "description": "If a network is enabled for 'streched l2 subnet' then represents zones on which network currently spans", - "name": "zonesnetworkspans", - "type": "set" - }, { - "description": "list networks available for vm deployment", - "name": "canusefordeploy", - "type": "boolean" + "description": "the type of the network", + "name": "type", + "type": "string" }, { - "description": "true network requires restart", - "name": "restartrequired", - "type": "boolean" + "description": "related to what other network configuration", + "name": "related", + "type": "string" }, { - "description": "true if network is system, false otherwise", - "name": "issystem", - "type": "boolean" + "description": "The routing mode of network offering", + "name": "ip6routing", + "type": "string" }, { - "description": "Broadcast domain type of the network", - "name": "broadcastdomaintype", + "description": "the network's gateway", + "name": "gateway", "type": "string" }, { @@ -93601,38 +95426,33 @@ "type": "string" }, { - "description": "the date this network was created", - "name": "created", - "type": "date" - }, - { - "description": "the project id of the ipaddress", - "name": "projectid", - "type": "string" + "description": "If a network is enabled for 'streched l2 subnet' then represents zones on which network currently spans", + "name": "zonesnetworkspans", + "type": "set" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the owner of the network", + "name": "account", "type": "string" }, { - "description": "the name of the zone the network belongs to", - "name": "zonename", + "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": "true if network is system, false otherwise", + "name": "issystem", + "type": "boolean" }, { - "description": "the network CIDR of the guest network configured with IP reservation. It is the summation of CIDR and RESERVED_IP_RANGE", - "name": "networkcidr", + "description": "state of the network", + "name": "state", "type": "string" }, { - "description": "the network domain", - "name": "networkdomain", + "description": "the id of the network", + "name": "id", "type": "string" }, { @@ -93659,14 +95479,14 @@ "type": "list" }, { - "description": "uuid of the network provider", - "name": "id", + "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 physical network this belongs to", @@ -93674,13 +95494,13 @@ "type": "string" }, { - "description": "true if individual services can be enabled/disabled", - "name": "canenableindividualservice", - "type": "boolean" + "description": "uuid of the network provider", + "name": "id", + "type": "string" }, { - "description": "the provider name", - "name": "name", + "description": "state of the network provider", + "name": "state", "type": "string" } ], @@ -93690,11 +95510,6 @@ "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", @@ -93704,6 +95519,11 @@ "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" @@ -93712,18 +95532,95 @@ "type": "list" }, { - "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 project id of the ipaddress", + "name": "projectid", "type": "string" }, { - "description": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR", - "name": "cidr", + "description": "availability of the network offering the network is created from", + "name": "networkofferingavailability", "type": "string" }, { - "description": "the name of the network", - "name": "name", + "description": "the list of resource tags associated with network", + "name": "tags", + "response": [ + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + } + ], + "type": "list" + }, + { + "description": "the network domain", + "name": "networkdomain", + "type": "string" + }, + { + "description": "the name of the Network associated with this network", + "name": "associatednetwork", + "type": "string" + }, + { + "description": "true if network offering is ip conserve mode enabled", + "name": "networkofferingconservemode", + "type": "boolean" + }, + { + "description": "network offering id the network is created from", + "name": "networkofferingid", "type": "string" }, { @@ -93732,53 +95629,65 @@ "type": "string" }, { - "description": "the details of the network", - "name": "details", - "type": "map" + "description": "true if network can span multiple zones", + "name": "strechedl2subnet", + "type": "boolean" }, { - "description": "If the network has redundant routers enabled", - "name": "redundantrouter", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the domain id of the network owner", - "name": "domainid", + "description": "the ID of the Network associated with this network", + "name": "associatednetworkid", "type": "string" }, + {}, + {}, { - "description": "the network's gateway", - "name": "gateway", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "true if network offering is ip conserve mode enabled", - "name": "networkofferingconservemode", - "type": "boolean" + "description": "acl type - access type to the network", + "name": "acltype", + "type": "string" }, { - "description": "the type of the network", - "name": "type", + "description": "the ID of the Network associated with this private gateway", + "name": "associatednetworkid", "type": "string" }, { - "description": "the traffic type of the network", - "name": "traffictype", + "description": "Name of the VPC to which this network belongs", + "name": "vpcname", "type": "string" }, { - "description": "the owner of the network", - "name": "account", + "description": "ACL name associated with the VPC network", + "name": "aclname", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "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", + "description": "the network's IP range not to be used by CloudStack guest VMs and can be used for non CloudStack purposes", + "name": "reservediprange", + "type": "string" + }, + { + "description": "the name of the network", + "name": "name", + "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" }, { @@ -93787,39 +95696,54 @@ "type": "string" }, { - "description": "related to what other network configuration", - "name": "related", + "description": "true if users from subdomains can access the domain level network", + "name": "subdomainaccess", + "type": "boolean" + }, + { + "description": "the domain id of the network owner", + "name": "domainid", + "type": "string" + }, + { + "description": "the details of the network", + "name": "details", + "type": "map" + }, + { + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" + }, + { + "description": "the network's netmask", + "name": "netmask", "type": "string" }, { - "description": "the id of the network", - "name": "id", + "description": "the second DNS for the network", + "name": "dns2", "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": "state of the network", - "name": "state", - "type": "string" + "description": "true if network is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "the network's netmask", - "name": "netmask", + "description": "Broadcast domain type of the network", + "name": "broadcastdomaintype", "type": "string" }, { - "description": "an optional field, whether to the display the network to the end user or not.", - "name": "displaynetwork", + "description": "list networks that are persistent", + "name": "ispersistent", "type": "boolean" - }, - { - "description": "name of the network offering the network is created from", - "name": "networkofferingname", - "type": "string" } ] }, @@ -93838,23 +95762,23 @@ } ], "response": [ + {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, - {}, - {}, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "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", @@ -93868,14 +95792,6 @@ "isasync": true, "name": "dedicateHost", "params": [ - { - "description": "the ID of the host to update", - "length": 255, - "name": "hostid", - "related": "reconnectHost,addBaremetalHost", - "required": true, - "type": "uuid" - }, { "description": "the ID of the containing domain", "length": 255, @@ -93890,30 +95806,43 @@ "name": "account", "required": false, "type": "string" + }, + { + "description": "the ID of the host to update", + "length": 255, + "name": "hostid", + "related": "addBaremetalHost,reconnectHost", + "required": true, + "type": "uuid" } ], "related": "listDedicatedHosts", "response": [ {}, - { - "description": "the Account ID of the host", - "name": "accountid", - "type": "string" - }, { "description": "the ID of the host", "name": "hostid", "type": "string" }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, {}, + { + "description": "the domain ID of the host", + "name": "domainid", + "type": "string" + }, { "description": "the Dedication Affinity Group ID of the host", "name": "affinitygroupid", "type": "string" }, { - "description": "the ID of the dedicated resource", - "name": "id", + "description": "the name of the host", + "name": "hostname", "type": "string" }, { @@ -93922,18 +95851,13 @@ "type": "string" }, { - "description": "the name of the host", - "name": "hostname", + "description": "the ID of the dedicated resource", + "name": "id", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the domain ID of the host", - "name": "domainid", + "description": "the Account ID of the host", + "name": "accountid", "type": "string" } ] @@ -93943,20 +95867,6 @@ "isasync": true, "name": "removeVpnUser", "params": [ - { - "description": "username for the vpn user", - "length": 255, - "name": "username", - "required": true, - "type": "string" - }, - { - "description": "an optional account for the vpn user. Must be used with domainId.", - "length": 255, - "name": "account", - "required": false, - "type": "string" - }, { "description": "remove vpn user from the project", "length": 255, @@ -93965,6 +95875,13 @@ "required": false, "type": "uuid" }, + { + "description": "username for the vpn user", + "length": 255, + "name": "username", + "required": true, + "type": "string" + }, { "description": "an optional domainId for the vpn user. If the account parameter is used, domainId must also be used.", "length": 255, @@ -93972,17 +95889,24 @@ "related": "listDomainChildren,listDomains", "required": false, "type": "uuid" + }, + { + "description": "an optional account for the vpn user. Must be used with domainId.", + "length": 255, + "name": "account", + "required": false, + "type": "string" } ], "response": [ { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, {}, @@ -94005,12 +95929,11 @@ "name": "addGloboDnsHost", "params": [ { - "description": "the Physical Network ID", + "description": "Password for GloboDNS", "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork", + "name": "password", "required": true, - "type": "uuid" + "type": "string" }, { "description": "GloboDNS url", @@ -94020,42 +95943,43 @@ "type": "string" }, { - "description": "Username for GloboDNS", + "description": "the Physical Network ID", "length": 255, - "name": "username", + "name": "physicalnetworkid", + "related": "createPhysicalNetwork", "required": true, - "type": "string" + "type": "uuid" }, { - "description": "Password for GloboDNS", + "description": "Username for GloboDNS", "length": 255, - "name": "password", + "name": "username", "required": true, "type": "string" } ], "response": [ { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, + {}, { "description": "true if operation is executed successfully", "name": "success", "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": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" } ], "since": "4.5.0" @@ -94067,23 +95991,23 @@ "params": [], "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 current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "Response description", "name": "description", "type": "string" - } + }, + {}, + {} ] }, { @@ -94101,16 +96025,6 @@ } ], "response": [ - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - }, { "description": "true if operation is executed successfully", "name": "success", @@ -94122,7 +96036,17 @@ "name": "jobid", "type": "string" }, - {} + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + }, + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } ], "since": "4.2.0" }, @@ -94132,11 +96056,18 @@ "name": "importRole", "params": [ { - "description": "Rules param list, rule and permission is must. Example: rules[0].rule=create*&rules[0].permission=allow&rules[0].description=create%20rule&rules[1].rule=list*&rules[1].permission=allow&rules[1].description=listing", + "description": "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": "rules", - "required": true, - "type": "map" + "name": "forced", + "required": false, + "type": "boolean" + }, + { + "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", @@ -94153,40 +96084,35 @@ "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" - }, - { - "description": "The type of the role, valid options are: Admin, ResourceAdmin, DomainAdmin, User", + "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": "type", - "required": false, - "type": "string" + "name": "rules", + "required": true, + "type": "map" } ], "related": "", "response": [ + {}, + { + "description": "the description of the role", + "name": "description", + "type": "string" + }, + {}, { "description": "true if role is default, false otherwise", "name": "isdefault", "type": "boolean" }, { - "description": "the type of the role", - "name": "type", - "type": "string" - }, - { - "description": "the description of the role", - "name": "description", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the name of the role", - "name": "name", + "description": "the type of the role", + "name": "type", "type": "string" }, { @@ -94199,12 +96125,10 @@ "name": "id", "type": "string" }, - {}, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the name of the role", + "name": "name", + "type": "string" } ], "since": "4.15.0" @@ -94215,11 +96139,11 @@ "name": "listSwifts", "params": [ { - "description": "the id of the swift", + "description": "", "length": 255, - "name": "id", + "name": "page", "required": false, - "type": "long" + "type": "integer" }, { "description": "", @@ -94229,42 +96153,41 @@ "type": "integer" }, { - "description": "List by keyword", + "description": "the id of the swift", "length": 255, - "name": "keyword", + "name": "id", "required": false, - "type": "string" + "type": "long" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "page", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" } ], "related": "addImageStoreS3,listImageStores", "response": [ { - "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 name of the image store", + "name": "name", + "type": "string" }, - {}, { - "description": "the Zone ID of the image store", - "name": "zoneid", + "description": "the Zone name of the image store", + "name": "zonename", "type": "string" }, { - "description": "the scope of the image store", - "name": "scope", - "type": "scopetype" + "description": "the protocol of the image store", + "name": "protocol", + "type": "string" }, { "description": "true if the entity/resource has annotations", @@ -94272,50 +96195,51 @@ "type": "boolean" }, { - "description": "the url of the image store", - "name": "url", + "description": "the ID of the image store", + "name": "id", "type": "string" }, { - "description": "the protocol of the image store", - "name": "protocol", + "description": "the provider name of the image store", + "name": "providername", "type": "string" }, + {}, { - "description": "the Zone name of the image store", - "name": "zonename", - "type": "string" + "description": "the total disk size of the host", + "name": "disksizetotal", + "type": "long" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the scope of the image store", + "name": "scope", + "type": "scopetype" + }, + { + "description": "defines if store is read-only", + "name": "readonly", + "type": "boolean" }, { "description": "the host's currently used disk size", "name": "disksizeused", "type": "long" }, + {}, { - "description": "the provider name of the image store", - "name": "providername", + "description": "the 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 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 ID of the image store", - "name": "id", - "type": "string" } ], "since": "3.0.0" @@ -94329,50 +96253,50 @@ "description": "ID of the host", "length": 255, "name": "hostid", - "related": "reconnectHost,addBaremetalHost", + "related": "addBaremetalHost,reconnectHost", "required": true, "type": "uuid" } ], "related": "", "response": [ - { - "description": "if host HA is enabled for the host", - "name": "haenable", - "type": "boolean" - }, - { - "description": "the HA state of the host", - "name": "hastate", - "type": "hastate" - }, - {}, - {}, { "description": "the 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": "operation status", "name": "status", "type": "boolean" }, { - "description": "the host HA provider", - "name": "haprovider", - "type": "string" + "description": "the HA state of the host", + "name": "hastate", + "type": "hastate" }, { - "description": "the ID of the host", - "name": "hostid", - "type": "string" + "description": "if host HA is enabled for the host", + "name": "haenable", + "type": "boolean" }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - } + }, + { + "description": "the host HA provider", + "name": "haprovider", + "type": "string" + }, + {} ], "since": "4.11" }, @@ -94385,7 +96309,7 @@ "description": "the ID of the host", "length": 255, "name": "hostid", - "related": "reconnectHost,addBaremetalHost", + "related": "addBaremetalHost,reconnectHost", "required": true, "type": "uuid" } @@ -94393,23 +96317,29 @@ "related": "disableOutOfBandManagementForCluster", "response": [ { - "description": "the out-of-band management driver for the host", - "name": "driver", - "type": "string" + "description": "the out-of-band management interface powerState of the host", + "name": "powerstate", + "type": "powerstate" }, { - "description": "the 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 action (if issued)", - "name": "action", + "description": "the out-of-band management interface address", + "name": "address", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "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" }, { @@ -94417,41 +96347,35 @@ "name": "password", "type": "string" }, - {}, { - "description": "true if out-of-band management is enabled for the host", - "name": "enabled", - "type": "boolean" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, - {}, { "description": "the out-of-band management interface port", "name": "port", "type": "string" }, - { - "description": "the ID of the host", - "name": "hostid", - "type": "string" - }, { "description": "the out-of-band management interface username", "name": "username", "type": "string" }, + {}, { - "description": "the out-of-band management interface powerState of the host", - "name": "powerstate", - "type": "powerstate" + "description": "the out-of-band management action (if issued)", + "name": "action", + "type": "string" }, { - "description": "the operation result", - "name": "status", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the out-of-band management interface address", - "name": "address", + "description": "the out-of-band management driver for the host", + "name": "driver", "type": "string" }, { @@ -94477,27 +96401,27 @@ } ], "response": [ + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, {}, - {}, - { - "description": "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" } ] }, @@ -94514,27 +96438,25 @@ "type": "string" }, { - "description": "the ID of the zone in which Kubernetes supported version will be available", + "description": "", "length": 255, - "name": "zoneid", - "related": "createZone,listZones", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "the ID of the minimum Kubernetes supported version", + "description": "List by keyword", "length": 255, - "name": "minimumkubernetesversionid", - "related": "listKubernetesSupportedVersions", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { "description": "the ID of the Kubernetes supported version", @@ -94545,18 +96467,20 @@ "type": "uuid" }, { - "description": "", + "description": "the ID of the zone in which Kubernetes supported version will be available", "length": 255, - "name": "pagesize", + "name": "zoneid", + "related": "createZone,listZones", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "", + "description": "the ID of the minimum Kubernetes supported version", "length": 255, - "name": "page", + "name": "minimumkubernetesversionid", + "related": "listKubernetesSupportedVersions", "required": false, - "type": "integer" + "type": "uuid" } ], "related": "", @@ -94566,61 +96490,54 @@ "name": "state", "type": "string" }, - {}, { - "description": "the id of the Kubernetes supported version", - "name": "id", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the id of the zone in which Kubernetes supported version is available", - "name": "zoneid", + "description": "the state of the binaries ISO for Kubernetes supported version", + "name": "isostate", "type": "string" }, { - "description": "Name of the Kubernetes supported version", - "name": "name", + "description": "the id of the Kubernetes supported version", + "name": "id", "type": "string" }, { - "description": "whether Kubernetes supported version supports Autoscaling", - "name": "supportsautoscaling", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, - {}, { "description": "the name of the binaries ISO for Kubernetes supported version", "name": "isoname", "type": "string" }, { - "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": "the state of the binaries ISO for Kubernetes supported version", - "name": "isostate", + "description": "the id of the binaries ISO for Kubernetes supported version", + "name": "isoid", "type": "string" }, { - "description": "Kubernetes semantic version", - "name": "semanticversion", + "description": "the name of the zone in which Kubernetes supported version is available", + "name": "zonename", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "whether Kubernetes supported version supports Autoscaling", + "name": "supportsautoscaling", + "type": "boolean" }, { - "description": "the name of the zone in which Kubernetes supported version is available", - "name": "zonename", + "description": "Name of the Kubernetes supported version", + "name": "name", "type": "string" }, { @@ -94628,11 +96545,23 @@ "name": "mincpunumber", "type": "integer" }, + {}, { "description": "whether Kubernetes supported version supports HA, multi-control nodes", "name": "supportsha", "type": "boolean" }, + { + "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 minimum RAM size in MB needed for the Kubernetes supported version", "name": "minmemory", @@ -94646,17 +96575,17 @@ "name": "addNiciraNvpDevice", "params": [ { - "description": "Credentials to access the Nicira Controller API", + "description": "The L3 Gateway Service UUID configured on the Nicira Controller", "length": 255, - "name": "username", - "required": true, + "name": "l3gatewayserviceuuid", + "required": false, "type": "string" }, { - "description": "The L2 Gateway Service UUID configured on the Nicira Controller", + "description": "Credentials to access the Nicira Controller API", "length": 255, - "name": "l2gatewayserviceuuid", - "required": false, + "name": "username", + "required": true, "type": "string" }, { @@ -94667,26 +96596,26 @@ "type": "string" }, { - "description": "the Physical Network ID", + "description": "The Transportzone UUID configured on the Nicira Controller", "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork", + "name": "transportzoneuuid", "required": true, - "type": "uuid" + "type": "string" }, { - "description": "The L3 Gateway Service UUID configured on the Nicira Controller", + "description": "The L2 Gateway Service UUID configured on the Nicira Controller", "length": 255, - "name": "l3gatewayserviceuuid", + "name": "l2gatewayserviceuuid", "required": false, "type": "string" }, { - "description": "The Transportzone UUID configured on the Nicira Controller", + "description": "the Physical Network ID", "length": 255, - "name": "transportzoneuuid", + "name": "physicalnetworkid", + "related": "createPhysicalNetwork", "required": true, - "type": "string" + "type": "uuid" }, { "description": "Hostname of ip address of the Nicira NVP Controller.", @@ -94698,29 +96627,26 @@ ], "related": "", "response": [ + {}, { "description": "device id of the Nicire Nvp", "name": "nvpdeviceid", "type": "string" }, - { - "description": "the transport zone Uuid", - "name": "transportzoneuuid", - "type": "string" - }, { "description": "name of the provider", "name": "provider", "type": "string" }, { - "description": "the physical network to which this Nirica Nvp belongs to", - "name": "physicalnetworkid", + "description": "the transport zone Uuid", + "name": "transportzoneuuid", "type": "string" }, + {}, { - "description": "this L2 gateway service Uuid", - "name": "l2gatewayserviceuuid", + "description": "the physical network to which this Nirica Nvp belongs to", + "name": "physicalnetworkid", "type": "string" }, { @@ -94728,134 +96654,29 @@ "name": "l3gatewayserviceuuid", "type": "string" }, - {}, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, { "description": "device name", "name": "niciradevicename", "type": "string" }, { - "description": "the controller Ip address", - "name": "hostname", - "type": "string" - } - ] - }, - { - "description": "Adds a F5 BigIP load balancer device", - "isasync": true, - "name": "addF5LoadBalancer", - "params": [ - { - "description": "Credentials to reach F5 BigIP load balancer device", - "length": 255, - "name": "password", - "required": true, - "type": "string" - }, - { - "description": "the Physical Network ID", - "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork", - "required": true, - "type": "uuid" - }, - { - "description": "Credentials to reach F5 BigIP load balancer device", - "length": 255, - "name": "username", - "required": true, - "type": "string" - }, - { - "description": "URL of the F5 load balancer appliance.", - "length": 255, - "name": "url", - "required": true, + "description": "this L2 gateway service Uuid", + "name": "l2gatewayserviceuuid", "type": "string" }, - { - "description": "supports only F5BigIpLoadBalancer", - "length": 255, - "name": "networkdevicetype", - "required": true, - "type": "string" - } - ], - "related": "", - "response": [ { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "device capacity", - "name": "lbdevicecapacity", - "type": "long" - }, - { - "description": "the physical network to which this F5 device belongs to", - "name": "physicalnetworkid", - "type": "string" - }, - { - "description": "the public interface of the load balancer", - "name": "publicinterface", - "type": "string" - }, - { - "description": "device state", - "name": "lbdevicestate", - "type": "string" - }, - { - "description": "device id of the F5 load balancer", - "name": "lbdeviceid", - "type": "string" - }, - {}, - {}, - { - "description": "name of the provider", - "name": "provider", - "type": "string" - }, - { - "description": "the private interface of the load balancer", - "name": "privateinterface", - "type": "string" - }, - { - "description": "the management IP address of the external load balancer", - "name": "ipaddress", - "type": "string" - }, - { - "description": "true if device is dedicated for an account", - "name": "lbdevicededicated", - "type": "boolean" - }, - { - "description": "device name", - "name": "lbdevicename", + "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 controller Ip address", + "name": "hostname", "type": "string" } ] @@ -94866,11 +96687,12 @@ "name": "listNetworkServiceProviders", "params": [ { - "description": "list providers by name", + "description": "the Physical Network ID", "length": 255, - "name": "name", + "name": "physicalnetworkid", + "related": "createPhysicalNetwork", "required": false, - "type": "string" + "type": "uuid" }, { "description": "List by keyword", @@ -94880,19 +96702,11 @@ "type": "string" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, - { - "description": "the Physical Network ID", + "description": "list providers by state", "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork", + "name": "state", "required": false, - "type": "uuid" + "type": "string" }, { "description": "", @@ -94902,28 +96716,35 @@ "type": "integer" }, { - "description": "list providers by state", + "description": "list providers by name", "length": 255, - "name": "state", + "name": "name", "required": false, "type": "string" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" } ], "related": "", "response": [ { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", - "type": "string" + "description": "true if individual services can be enabled/disabled", + "name": "canenableindividualservice", + "type": "boolean" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the provider name", + "name": "name", + "type": "string" }, { - "description": "state of the network provider", - "name": "state", + "description": "the destination physical network", + "name": "destinationphysicalnetworkid", "type": "string" }, { @@ -94932,32 +96753,32 @@ "type": "string" }, { - "description": "services for this provider", - "name": "servicelist", - "type": "list" - }, - { - "description": "the provider name", - "name": "name", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "state of the network provider", + "name": "state", "type": "string" }, { - "description": "the destination physical network", - "name": "destinationphysicalnetworkid", + "description": "the physical network this belongs to", + "name": "physicalnetworkid", "type": "string" }, {}, { - "description": "true if individual services can be enabled/disabled", - "name": "canenableindividualservice", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, - {} + {}, + { + "description": "services for this provider", + "name": "servicelist", + "type": "list" + } ], "since": "3.0.0" }, @@ -94969,18 +96790,18 @@ "related": "", "response": [ { - "description": "Number of management servers", - "name": "managementservers", + "description": "Number of zones", + "name": "zones", "type": "integer" }, { - "description": "Number of Alerts", - "name": "alerts", + "description": "Number of storage pools", + "name": "storagepools", "type": "integer" }, { - "description": "Number of hypervisor hosts", - "name": "hosts", + "description": "Number of cpu sockets", + "name": "cpusockets", "type": "integer" }, { @@ -94989,39 +96810,46 @@ "type": "integer" }, { - "description": "Number of cpu sockets", - "name": "cpusockets", + "description": "Number of Alerts", + "name": "alerts", "type": "integer" }, { - "description": "Number of internal LBs", - "name": "ilbvms", + "description": "Number of management servers", + "name": "managementservers", "type": "integer" }, { - "description": "Number of zones", - "name": "zones", + "description": "Number of hypervisor hosts", + "name": "hosts", + "type": "integer" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, + {}, { "description": "Number of systemvms", "name": "systemvms", "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "Number of images stores", + "name": "imagestores", + "type": "integer" }, { - "description": "Number of storage pools", - "name": "storagepools", + "description": "Number of pods", + "name": "pods", "type": "integer" }, + {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { "description": "Number of routers", @@ -95029,17 +96857,10 @@ "type": "integer" }, { - "description": "Number of images stores", - "name": "imagestores", - "type": "integer" - }, - {}, - { - "description": "Number of pods", - "name": "pods", + "description": "Number of internal LBs", + "name": "ilbvms", "type": "integer" - }, - {} + } ], "since": "4.9.3" }, @@ -95049,28 +96870,18 @@ "name": "listUsageRecords", "params": [ { - "description": "List usage records for the specified account", - "length": 255, - "name": "accountid", - "related": "enableAccount,listAccounts,listAccounts", - "required": false, - "type": "uuid" - }, - { - "description": "Specify if usage records should be fetched recursively per domain. If an account id is passed, records will be limited to that account.", + "description": "List usage records for the specified usage type", "length": 255, - "name": "isrecursive", + "name": "type", "required": false, - "since": "4.15", - "type": "boolean" + "type": "long" }, { - "description": "List usage records for the specified domain.", + "description": "List by keyword", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" }, { "description": "Flag to enable description rendered in old format which uses internal database IDs instead of UUIDs. False by default.", @@ -95079,13 +96890,6 @@ "required": false, "type": "boolean" }, - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - }, { "description": "End date range for usage record query (use format \"yyyy-MM-dd\" or the new format \"yyyy-MM-dd HH:mm:ss\", e.g. startDate=2015-01-01 or startdate=2015-01-01 10:30:00).", "length": 255, @@ -95093,19 +96897,27 @@ "required": true, "type": "date" }, + { + "description": "Specify if usage records should be fetched recursively per domain. If an account id is passed, records will be limited to that account.", + "length": 255, + "name": "isrecursive", + "required": false, + "since": "4.15", + "type": "boolean" + }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, { - "description": "List usage records for the specified user.", + "description": "Flag to enable display of Tags for a resource", "length": 255, - "name": "account", + "name": "includetags", "required": false, - "type": "string" + "type": "boolean" }, { "description": "List usage records for specified project", @@ -95123,25 +96935,26 @@ "type": "string" }, { - "description": "List usage records for the specified usage type", + "description": "List usage records for the specified domain.", "length": 255, - "name": "type", + "name": "domainid", + "related": "listDomainChildren,listDomains", "required": false, - "type": "long" + "type": "uuid" }, { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, { - "description": "Flag to enable display of Tags for a resource", + "description": "List usage records for the specified user.", "length": 255, - "name": "includetags", + "name": "account", "required": false, - "type": "boolean" + "type": "string" }, { "description": "Start date range for usage record query (use format \"yyyy-MM-dd\" or the new format \"yyyy-MM-dd HH:mm:ss\", e.g. startDate=2015-01-01 or startdate=2015-01-01 11:00:00).", @@ -95149,6 +96962,14 @@ "name": "startdate", "required": true, "type": "date" + }, + { + "description": "List usage records for the specified account", + "length": 255, + "name": "accountid", + "related": "enableAccount,listAccounts,listAccounts", + "required": false, + "type": "uuid" } ], "related": "", @@ -95159,70 +96980,74 @@ "type": "string" }, { - "description": "True if the IPAddress is system IP - allocated during vm deploy or lb rule create", - "name": "issystem", - "type": "boolean" + "description": "id of the resource", + "name": "usageid", + "type": "string" }, { - "description": "the user account name", - "name": "account", + "description": "the domain the resource is associated with", + "name": "domain", "type": "string" }, { - "description": "raw usage in hours", - "name": "rawusage", - "type": "string" + "description": "memory allocated for the resource", + "name": "memory", + "type": "long" }, { - "description": "id of the network", - "name": "networkid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the project name of the resource", - "name": "project", + "description": "resource or virtual machine name", + "name": "name", "type": "string" }, { - "description": "resource type", - "name": "type", + "description": "number of cpu of resource", + "name": "cpunumber", + "type": "long" + }, + { + "description": "the user account name", + "name": "account", "type": "string" }, { - "description": "id of the resource", - "name": "usageid", + "description": "id of the vpc", + "name": "vpcid", "type": "string" }, { - "description": "usage type ID", - "name": "usagetype", - "type": "integer" + "description": "True if the IPAddress is source NAT", + "name": "issourcenat", + "type": "boolean" }, { - "description": "resource or virtual machine name", - "name": "name", - "type": "string" + "description": "speed of each cpu of resource", + "name": "cpuspeed", + "type": "long" }, { - "description": "True if the resource is default", - "name": "isdefault", - "type": "boolean" + "description": "resource size", + "name": "size", + "type": "long" }, - {}, { - "description": "template ID", - "name": "templateid", + "description": "the user account Id", + "name": "accountid", "type": "string" }, { - "description": "virtual machine os display name", - "name": "osdisplayname", + "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": "offering ID", @@ -95230,52 +97055,68 @@ "type": "string" }, { - "description": "end date of the usage record", - "name": "enddate", - "type": "string" + "description": "True if the IPAddress is system IP - allocated during vm deploy or lb rule create", + "name": "issystem", + "type": "boolean" }, { - "description": "id of the vpc", - "name": "vpcid", + "description": "the project name of the resource", + "name": "project", "type": "string" }, { - "description": "the zone ID", - "name": "zoneid", + "description": "usage type ID", + "name": "usagetype", + "type": "integer" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "end date of the usage record", + "name": "enddate", + "type": "string" }, { - "description": "usage in hours", - "name": "usage", + "description": "the domain ID", + "name": "domainid", "type": "string" }, { - "description": "speed of each cpu of resource", - "name": "cpuspeed", - "type": "long" + "description": "raw usage in hours", + "name": "rawusage", + "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "True if the resource is default", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "virtual machine ID", + "name": "virtualmachineid", + "type": "string" }, { "description": "the list of resource tags associated", "name": "tags", "response": [ { - "description": "resource type", - "name": "resourcetype", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { @@ -95284,18 +97125,18 @@ "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { @@ -95304,92 +97145,72 @@ "type": "string" }, { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "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": "number of cpu of resource", - "name": "cpunumber", - "type": "long" + "description": "resource type", + "name": "type", + "type": "string" }, { - "description": "the user account Id", - "name": "accountid", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { "description": "virtual machine guest os category ID", "name": "oscategoryid", "type": "string" }, - { - "description": "virtual machine os category name", - "name": "oscategoryname", - "type": "string" - }, - { - "description": "the domain the resource is associated with", - "name": "domain", - "type": "string" - }, - { - "description": "virtual machine ID", - "name": "virtualmachineid", - "type": "string" - }, - { - "description": "the domain ID", - "name": "domainid", - "type": "string" - }, { "description": "virtual size of resource", "name": "virtualsize", "type": "long" }, + { + "description": "virtual machine os display name", + "name": "osdisplayname", + "type": "string" + }, + {}, { "description": "the project id of the resource", "name": "projectid", "type": "string" }, { - "description": "start date of the usage record", - "name": "startdate", + "description": "the zone ID", + "name": "zoneid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "description of the usage record", + "name": "description", "type": "string" }, { - "description": "True if the IPAddress is source NAT", - "name": "issourcenat", - "type": "boolean" + "description": "usage in hours", + "name": "usage", + "type": "string" }, - {}, { - "description": "memory allocated for the resource", - "name": "memory", - "type": "long" + "description": "template ID", + "name": "templateid", + "type": "string" }, { - "description": "description of the usage record", - "name": "description", + "description": "start date of the usage record", + "name": "startdate", "type": "string" } ] @@ -95410,9 +97231,9 @@ ], "response": [ { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, { "description": "the current status of the latest async job acting on this object", @@ -95422,9 +97243,9 @@ {}, {}, { - "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", @@ -95449,26 +97270,26 @@ ], "response": [ { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, + {}, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" }, - {}, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, {} ] }, @@ -95489,14 +97310,14 @@ "related": "createVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", "response": [ { - "description": "io requests write rate of the disk volume per the disk offering", - "name": "diskIopsWriteRate", - "type": "long" + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", + "type": "string" }, { - "description": "provisioning type used to create volumes.", - "name": "provisioningtype", - "type": "string" + "description": "the date the volume was attached to a VM instance", + "name": "attached", + "type": "date" }, { "description": "bytes read rate of the disk volume", @@ -95504,286 +97325,281 @@ "type": "long" }, { - "description": "min iops of the disk volume", - "name": "miniops", - "type": "long" + "description": "cluster id of the volume", + "name": "clusterid", + "type": "string" }, { - "description": "io requests read rate of the disk volume per the disk offering", - "name": "diskIopsReadRate", - "type": "long" + "description": "need quiesce vm or not when taking snapshot", + "name": "quiescevm", + "type": "boolean" }, { - "description": "name of the virtual machine", - "name": "vmname", + "description": "type of the disk volume (ROOT or DATADISK)", + "name": "type", "type": "string" }, { - "description": "the status of the volume", - "name": "status", + "description": "the disk utilization", + "name": "utilization", "type": "string" }, { - "description": "name of the service offering for root disk", - "name": "serviceofferingname", + "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", + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", "type": "string" }, { - "description": "pod id of the volume", - "name": "podid", + "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", - "type": "string" + "description": "the bytes actually consumed on disk", + "name": "virtualsize", + "type": "long" }, { - "description": "ID of the snapshot from which this volume was created", - "name": "snapshotid", - "type": "string" + "description": "IO requests read rate of the disk volume per the disk offering", + "name": "diskIopsReadRate", + "type": "long" }, { - "description": "the project id of the vpn", - "name": "projectid", + "description": "shared or local storage", + "name": "storagetype", "type": "string" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "name of the virtual machine", + "name": "vmname", "type": "string" }, { - "description": "the display text of the disk offering", - "name": "diskofferingdisplaytext", - "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 ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached.", + "name": "deviceid", + "type": "long" }, { - "description": "cluster id of the volume", - "name": "clusterid", + "description": "pod id of the volume", + "name": "podid", "type": "string" }, { - "description": "max iops of the disk volume", - "name": "maxiops", - "type": "long" - }, - { - "description": "the read (io) of disk on the vm", - "name": "diskioread", - "type": "long" + "description": "the project name of the vpn", + "name": "project", + "type": "string" }, { - "description": "name of the disk offering", - "name": "diskofferingname", + "description": "Hypervisor the volume belongs to", + "name": "hypervisor", "type": "string" }, { - "description": "display name of the virtual machine", - "name": "vmdisplayname", + "description": "volume uuid that is given by virtualisation provider (only for VMware)", + "name": "externaluuid", "type": "string" }, { - "description": "the read (bytes) of disk on the vm", - "name": "diskkbsread", + "description": "bytes write rate of the disk volume", + "name": "diskBytesWriteRate", "type": "long" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "name of the disk volume", + "name": "name", "type": "string" }, { - "description": "name of the primary storage hosting the disk volume", - "name": "storage", + "description": "ID of the disk offering", + "name": "diskofferingid", "type": "string" }, { - "description": "the date the volume was attached to a VM instance", - "name": "attached", - "type": "date" + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", + "type": "string" }, { - "description": "the bytes actually consumed on disk", - "name": "virtualsize", + "description": "the read (IO) of disk on the vm", + "name": "diskioread", "type": "long" }, { - "description": "bytes write rate of the disk volume", - "name": "diskBytesWriteRate", + "description": "the VM's disk read in KiB", + "name": "diskkbsread", "type": "long" }, { - "description": "the write (io) of disk on the vm", - "name": "diskiowrite", + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", "type": "long" }, { - "description": "need quiesce vm or not when taking snapshot", - "name": "quiescevm", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, + {}, { - "description": "name of the availability zone", - "name": "zonename", + "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", + "description": "ID of the snapshot from which this volume was created", + "name": "snapshotid", "type": "string" }, { - "description": "ID of the disk offering", - "name": "diskofferingid", + "description": "the path of the volume", + "name": "path", "type": "string" }, { - "description": "ID of the availability zone", - "name": "zoneid", + "description": "pod name of the volume", + "name": "podname", "type": "string" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "name of the disk offering", + "name": "diskofferingname", "type": "string" }, { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", - "type": "string" + "description": "true if storage snapshot is supported for the volume, false otherwise", + "name": "supportsstoragesnapshot", + "type": "boolean" }, { - "description": "the ID of the domain associated with the disk volume", - "name": "domainid", - "type": "string" + "description": "max iops of the disk volume", + "name": "maxiops", + "type": "long" }, { - "description": "the boolean state of whether the volume is destroyed or not", - "name": "destroyed", - "type": "boolean" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the project name of the vpn", - "name": "project", + "description": "cluster name where the volume is allocated", + "name": "clustername", "type": "string" }, { - "description": "true if storage snapshot is supported for the volume, false otherwise", - "name": "supportsstoragesnapshot", - "type": "boolean" + "description": "name of the service offering for root disk", + "name": "serviceofferingname", + "type": "string" }, + {}, { - "description": "cluster name where the volume is allocated", - "name": "clustername", + "description": "display name of the virtual machine", + "name": "vmdisplayname", "type": "string" }, { - "description": "the chain info of the volume", - "name": "chaininfo", + "description": "ID of the availability zone", + "name": "zoneid", "type": "string" }, { - "description": "the date the disk volume was created", - "name": "created", - "type": "date" + "description": "ID of the disk volume", + "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": "size of the disk volume", + "name": "size", + "type": "long" }, { - "description": "name of the disk volume", - "name": "name", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "description": "shared or local storage", - "name": "storagetype", + "description": "the display text of the service offering for root disk", + "name": "serviceofferingdisplaytext", "type": "string" }, { - "description": "ID of the service offering for root disk", - "name": "serviceofferingid", + "description": "true if the volume is extractable, false otherwise", + "name": "isextractable", + "type": "boolean" + }, + { + "description": "provisioning type used to create volumes.", + "name": "provisioningtype", "type": "string" }, { - "description": "type of the disk volume (ROOT or DATADISK)", - "name": "type", + "description": "name of the primary storage hosting the disk volume", + "name": "storage", "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": "id of the virtual machine", - "name": "virtualmachineid", + "description": "the project id of the vpn", + "name": "projectid", "type": "string" }, { - "description": "the bytes allocated", - "name": "physicalsize", + "description": "min iops of the disk volume", + "name": "miniops", "type": "long" }, { - "description": "the display text of the service offering for root disk", - "name": "serviceofferingdisplaytext", + "description": "the account associated with the disk volume", + "name": "account", "type": "string" }, { - "description": "the domain associated with the disk volume", - "name": "domain", - "type": "string" + "description": "an optional field whether to the display the volume to the end user or not.", + "name": "displayvolume", + "type": "boolean" }, { - "description": "pod name of the volume", - "name": "podname", - "type": "string" + "description": "the write (IO) of disk on the vm", + "name": "diskiowrite", + "type": "long" }, { - "description": "the disk utilization", - "name": "utilization", + "description": "id of the virtual machine", + "name": "virtualmachineid", "type": "string" }, - {}, { - "description": "ID of the disk volume", - "name": "id", + "description": "the display text of the disk offering", + "name": "diskofferingdisplaytext", "type": "string" }, { - "description": "true if the volume is extractable, false otherwise", - "name": "isextractable", + "description": "the boolean state of whether the volume is destroyed or not", + "name": "destroyed", "type": "boolean" }, { - "description": "the 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": "size of the disk volume", - "name": "size", - "type": "long" + "description": "ID of the service offering for root disk", + "name": "serviceofferingid", + "type": "string" }, { - "description": "the write (bytes) of disk on the vm", - "name": "diskkbswrite", - "type": "long" + "description": "state of the virtual machine", + "name": "vmstate", + "type": "string" }, { "description": "id of the primary storage hosting the disk volume; returned to admin user only", @@ -95791,13 +97607,13 @@ "type": "string" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", - "type": "string" + "description": "IO requests write rate of the disk volume per the disk offering", + "name": "diskIopsWriteRate", + "type": "long" }, { - "description": "the path of the volume", - "name": "path", + "description": "the domain associated with the disk volume", + "name": "domain", "type": "string" }, { @@ -95810,18 +97626,8 @@ "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", + "description": "tag key name", + "name": "key", "type": "string" }, { @@ -95830,13 +97636,13 @@ "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { @@ -95845,32 +97651,52 @@ "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "tag value", + "name": "value", "type": "string" }, { "description": "customer associated with the tag", "name": "customer", "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" } ], "type": "set" }, { - "description": "state of the virtual machine", - "name": "vmstate", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { - "description": "the account associated with the disk volume", - "name": "account", + "description": "the chain info of the volume", + "name": "chaininfo", "type": "string" }, { - "description": "Hypervisor the volume belongs to", - "name": "hypervisor", + "description": "the ID of the domain associated with the disk volume", + "name": "domainid", + "type": "string" + }, + { + "description": "the status of the volume", + "name": "status", "type": "string" + }, + { + "description": "the date the disk volume was created", + "name": "created", + "type": "date" } ], "since": "4.14.0" @@ -95891,65 +97717,70 @@ ], "related": "createUser,getUser", "response": [ + {}, { - "description": "the type of the role", - "name": "roletype", + "description": "the source type of the user in lowercase, such as native, ldap, saml2", + "name": "usersource", "type": "string" }, { - "description": "the secret key of the user", - "name": "secretkey", + "description": "the user state", + "name": "state", "type": "string" }, { - "description": "the domain ID of the user", - "name": "domainid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the account type of the user", - "name": "accounttype", - "type": "short" + "description": "the date and time the user account was created", + "name": "created", + "type": "date" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the user ID", + "name": "id", + "type": "string" }, { - "description": "the user name", - "name": "username", + "description": "the user firstname", + "name": "firstname", "type": "string" }, { - "description": "the timezone user was created in", - "name": "timezone", + "description": "the domain ID of the user", + "name": "domainid", "type": "string" }, { - "description": "the api key of the user", - "name": "apikey", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "true if user is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "the user lastname", + "name": "lastname", + "type": "string" }, { - "description": "the boolean value representing if the updating target is in caller's child domain", - "name": "iscallerchilddomain", - "type": "boolean" + "description": "the user name", + "name": "username", + "type": "string" }, { - "description": "the user lastname", - "name": "lastname", + "description": "the secret key of the user", + "name": "secretkey", "type": "string" }, - {}, { - "description": "the name of the role", - "name": "rolename", + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the account name of the user", + "name": "account", "type": "string" }, { @@ -95958,61 +97789,56 @@ "type": "string" }, { - "description": "the user email address", - "name": "email", + "description": "the account ID of the user", + "name": "accountid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the name of the role", + "name": "rolename", "type": "string" }, { - "description": "the date and time the user account was created", - "name": "created", - "type": "date" + "description": "the user email address", + "name": "email", + "type": "string" }, { - "description": "the user ID", - "name": "id", + "description": "the api key of the user", + "name": "apikey", "type": "string" }, { - "description": "the account name of the user", - "name": "account", - "type": "string" + "description": "true if user is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "the source type of the user in lowercase, such as native, ldap, saml2", - "name": "usersource", + "description": "the timezone user was created in", + "name": "timezone", "type": "string" }, - {}, { "description": "the domain name of the user", "name": "domain", "type": "string" }, { - "description": "the user firstname", - "name": "firstname", - "type": "string" + "description": "the boolean value representing if the updating target is in caller's child domain", + "name": "iscallerchilddomain", + "type": "boolean" }, { - "description": "the user state", - "name": "state", - "type": "string" + "description": "the account type of the user", + "name": "accounttype", + "type": "integer" }, { - "description": "the account ID of the user", - "name": "accountid", + "description": "the type of the role", + "name": "roletype", "type": "string" }, - { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - } + {} ] }, { @@ -96021,34 +97847,26 @@ "name": "listZonesMetrics", "params": [ { - "description": "flag to display the capacity of the zones", - "length": 255, - "name": "showcapacities", - "required": false, - "type": "boolean" - }, - { - "description": "List by keyword", + "description": "the ID of the zone", "length": 255, - "name": "keyword", + "name": "id", + "related": "createZone,listZones", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "the ID of the domain associated with the zone", + "description": "flag to display the resource image for the zones", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", + "name": "showicon", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "List zones by resource tags (key/value pairs)", + "description": "flag to display the capacity of the zones", "length": 255, - "name": "tags", + "name": "showcapacities", "required": false, - "since": "4.3", - "type": "map" + "type": "boolean" }, { "description": "", @@ -96065,11 +97883,11 @@ "type": "string" }, { - "description": "flag to display the resource image for the zones", + "description": "List by keyword", "length": 255, - "name": "showicon", + "name": "keyword", "required": false, - "type": "boolean" + "type": "string" }, { "description": "the network type of the zone that the virtual machine belongs to", @@ -96079,17 +97897,10 @@ "type": "string" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, - { - "description": "the ID of the zone", + "description": "the ID of the domain associated with the zone", "length": 255, - "name": "id", - "related": "createZone,listZones", + "name": "domainid", + "related": "listDomainChildren,listDomains", "required": false, "type": "uuid" }, @@ -96099,34 +97910,48 @@ "name": "available", "required": false, "type": "boolean" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, + { + "description": "List zones by resource tags (key/value pairs)", + "length": 255, + "name": "tags", + "required": false, + "since": "4.3", + "type": "map" } ], "related": "", "response": [ - {}, { - "description": "the maximum cpu deviation", - "name": "cpumaxdeviation", + "description": "the first DNS for the Zone", + "name": "dns1", "type": "string" }, { - "description": "the second DNS for the Zone", - "name": "dns2", - "type": "string" + "description": "memory usage disable threshold exceeded", + "name": "memorydisablethreshold", + "type": "boolean" }, { - "description": "the guest CIDR address for the Zone", - "name": "guestcidraddress", + "description": "Zone id", + "name": "id", "type": "string" }, { - "description": "true if security groups support is enabled, false otherwise", - "name": "securitygroupsenabled", - "type": "boolean" + "description": "Zone Token", + "name": "zonetoken", + "type": "string" }, { - "description": "the total cpu used in Ghz", - "name": "cpuused", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -96135,18 +97960,13 @@ "type": "boolean" }, { - "description": "the allocation state of the cluster", - "name": "allocationstate", - "type": "string" - }, - { - "description": "the total cpu allocated in GiB", - "name": "memoryallocated", - "type": "string" + "description": "cpu usage notification threshold exceeded", + "name": "cputhreshold", + "type": "boolean" }, { - "description": "the second internal DNS for the Zone", - "name": "internaldns2", + "description": "the display text of the zone", + "name": "displaytext", "type": "string" }, { @@ -96154,70 +97974,64 @@ "name": "ip6dns1", "type": "string" }, - {}, - { - "description": "Zone description", - "name": "description", - "type": "string" - }, { - "description": "the UUID of the containing domain, null for public zones", - "name": "domainid", - "type": "string" + "description": "memory usage notification threshold exceeded", + "name": "memorythreshold", + "type": "boolean" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "memory allocated disable threshold exceeded", + "name": "memoryallocateddisablethreshold", "type": "boolean" }, { - "description": "the total cpu capacity in Ghz", - "name": "cputotal", + "description": "the name of the containing domain, null for public zones", + "name": "domainname", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "memory allocated disable threshold exceeded", - "name": "memoryallocateddisablethreshold", - "type": "boolean" + "description": "Zone name", + "name": "name", + "type": "string" }, { - "description": "the first internal DNS for the Zone", - "name": "internaldns1", + "description": "Network domain name for the networks in the zone", + "name": "domain", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the total cpu used in GiB", + "name": "memoryused", + "type": "string" }, { "description": "the capacity of the Zone", "name": "capacity", "response": [ + { + "description": "the Cluster name", + "name": "clustername", + "type": "string" + }, + { + "description": "the capacity currently in allocated", + "name": "capacityallocated", + "type": "long" + }, { "description": "the capacity type", "name": "type", "type": "short" }, { - "description": "the Zone name", - "name": "zonename", - "type": "string" - }, - { - "description": "the Cluster name", - "name": "clustername", + "description": "the Cluster ID", + "name": "clusterid", "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 name", @@ -96225,18 +98039,18 @@ "type": "string" }, { - "description": "the capacity currently in use", - "name": "capacityused", - "type": "long" + "description": "the Zone ID", + "name": "zoneid", + "type": "string" }, { - "description": "the Pod ID", - "name": "podid", + "description": "the Zone name", + "name": "zonename", "type": "string" }, { - "description": "the Cluster ID", - "name": "clusterid", + "description": "the Pod ID", + "name": "podid", "type": "string" }, { @@ -96244,32 +98058,28 @@ "name": "name", "type": "string" }, - { - "description": "the Zone ID", - "name": "zoneid", - "type": "string" - }, { "description": "the total capacity available", "name": "capacitytotal", "type": "long" }, { - "description": "the capacity currently in allocated", - "name": "capacityallocated", - "type": "long" + "description": "the percentage of capacity currently in use", + "name": "percentused", + "type": "string" } ], "type": "list" }, + {}, { "description": "memory allocated notification threshold exceeded", "name": "memoryallocatedthreshold", "type": "boolean" }, { - "description": "Network domain name for the networks in the zone", - "name": "domain", + "description": "state of the cluster", + "name": "state", "type": "string" }, { @@ -96278,33 +98088,33 @@ "type": "string" }, { - "description": "the total cpu allocated in Ghz", - "name": "cpuallocated", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the first DNS for the Zone", - "name": "dns1", + "description": "the allocation state of the cluster", + "name": "allocationstate", "type": "string" }, { - "description": "the name of the containing domain, null for public zones", - "name": "domainname", + "description": "the total cpu capacity in GiB", + "name": "memorytotal", "type": "string" }, { - "description": "Zone Token", - "name": "zonetoken", - "type": "string" + "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": "the total cpu capacity in Ghz", + "name": "cputotal", "type": "string" }, { - "description": "state of the cluster", - "name": "state", + "description": "the second DNS for the Zone", + "name": "dns2", "type": "string" }, { @@ -96312,8 +98122,8 @@ "name": "tags", "response": [ { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { @@ -96321,29 +98131,24 @@ "name": "value", "type": "string" }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, { "description": "the project name where tag belongs to", "name": "project", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { @@ -96352,96 +98157,117 @@ "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 account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", "type": "string" } ], "type": "set" }, { - "description": "the dhcp Provider for the Zone", - "name": "dhcpprovider", + "description": "cpu allocated notification threshold exceeded", + "name": "cpuallocatedthreshold", + "type": "boolean" + }, + { + "description": "the network type of the zone; can be Basic or Advanced", + "name": "networktype", "type": "string" }, { - "description": "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": "Zone id", - "name": "id", + "description": "the first internal DNS for the Zone", + "name": "internaldns1", "type": "string" }, { - "description": "cpu usage disable threshold exceeded", - "name": "cpudisablethreshold", - "type": "boolean" + "description": "the maximum memory deviation", + "name": "memorymaxdeviation", + "type": "string" }, { - "description": "the network type of the zone; can be Basic or Advanced", - "name": "networktype", + "description": "the total cpu allocated in Ghz", + "name": "cpuallocated", "type": "string" }, { - "description": "the display text of the zone", - "name": "displaytext", + "description": "the maximum cpu deviation", + "name": "cpumaxdeviation", "type": "string" }, { - "description": "cpu allocated notification threshold exceeded", - "name": "cpuallocatedthreshold", - "type": "boolean" + "description": "Zone description", + "name": "description", + "type": "string" }, { - "description": "cpu allocated disable threshold exceeded", - "name": "cpuallocateddisablethreshold", + "description": "the guest CIDR address for the Zone", + "name": "guestcidraddress", + "type": "string" + }, + { + "description": "true if security groups support is enabled, false otherwise", + "name": "securitygroupsenabled", "type": "boolean" }, + {}, { - "description": "healthy / total clusters in the zone", - "name": "clusters", + "description": "the second internal DNS for the Zone", + "name": "internaldns2", "type": "string" }, { - "description": "the total cpu capacity in GiB", - "name": "memorytotal", + "description": "Meta data associated with the zone (key/value pairs)", + "name": "resourcedetails", + "type": "map" + }, + { + "description": "the UUID of the containing domain, null for public zones", + "name": "domainid", "type": "string" }, { - "description": "the total cpu used in GiB", - "name": "memoryused", + "description": "healthy / total clusters in the zone", + "name": "clusters", "type": "string" }, { - "description": "memory usage notification threshold exceeded", - "name": "memorythreshold", - "type": "boolean" + "description": "the total cpu used in Ghz", + "name": "cpuused", + "type": "string" }, { - "description": "memory usage disable threshold exceeded", - "name": "memorydisablethreshold", + "description": "cpu allocated disable threshold exceeded", + "name": "cpuallocateddisablethreshold", "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the dhcp Provider for the Zone", + "name": "dhcpprovider", "type": "string" }, { - "description": "Zone name", - "name": "name", + "description": "the total cpu allocated in GiB", + "name": "memoryallocated", "type": "string" }, { - "description": "cpu usage notification threshold exceeded", - "name": "cputhreshold", + "description": "cpu usage disable threshold exceeded", + "name": "cpudisablethreshold", "type": "boolean" } ], @@ -96453,12 +98279,11 @@ "name": "extractTemplate", "params": [ { - "description": "the ID of the template", - "length": 255, - "name": "id", - "related": "registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", - "required": true, - "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", @@ -96467,6 +98292,14 @@ "required": true, "type": "string" }, + { + "description": "the ID of the template", + "length": 255, + "name": "id", + "related": "registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", + "required": true, + "type": "uuid" + }, { "description": "the ID of the zone where the ISO is originally located", "length": 255, @@ -96474,41 +98307,25 @@ "related": "createZone,listZones", "required": false, "type": "uuid" - }, - { - "description": "the url to which the ISO would be extracted", - "length": 2048, - "name": "url", - "required": false, - "type": "string" } ], "related": "", "response": [ { - "description": "", - "name": "resultstring", - "type": "string" - }, - { - "description": "the mode of extraction - upload or download", - "name": "extractMode", - "type": "string" + "description": "the percentage of the entity uploaded to the specified location", + "name": "uploadpercentage", + "type": "integer" }, + {}, { "description": "the id of extracted object", "name": "id", "type": "string" }, { - "description": "the account id to which the extracted object belongs", - "name": "accountid", - "type": "string" - }, - { - "description": "the upload id of extracted object", - "name": "extractId", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "the state of the extracted object", @@ -96516,55 +98333,64 @@ "type": "string" }, { - "description": "zone ID the object was extracted from", - "name": "zoneid", + "description": "the status of the extraction", + "name": "status", "type": "string" }, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "if mode = upload then url of the uploaded entity. if mode = download the url from which the entity can be downloaded", "name": "url", "type": "string" }, { - "description": "zone name the object was extracted from", - "name": "zonename", + "description": "the mode of extraction - upload or download", + "name": "extractMode", "type": "string" }, { - "description": "the percentage of the entity uploaded to the specified location", - "name": "uploadpercentage", - "type": "integer" + "description": "", + "name": "resultstring", + "type": "string" }, - {}, { "description": "the time and date the object was created", "name": "created", "type": "date" }, + { + "description": "the name of the extracted object", + "name": "name", + "type": "string" + }, + {}, + { + "description": "zone ID the object was extracted from", + "name": "zoneid", + "type": "string" + }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "the name of the extracted object", - "name": "name", + "description": "zone name the object was extracted from", + "name": "zonename", "type": "string" }, { - "description": "the status of the extraction", - "name": "status", + "description": "type of the storage", + "name": "storagetype", "type": "string" }, { - "description": "type of the storage", - "name": "storagetype", + "description": "the upload id of extracted object", + "name": "extractId", + "type": "string" + }, + { + "description": "the account id to which the extracted object belongs", + "name": "accountid", "type": "string" } ] @@ -96584,13 +98410,18 @@ } ], "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", @@ -96600,11 +98431,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", - "type": "boolean" } ] }, @@ -96625,55 +98451,39 @@ "related": "activateProject", "response": [ { - "description": "the total secondary storage space (in GiB) owned by project", - "name": "secondarystoragetotal", - "type": "float" - }, - { - "description": "the total primary storage space (in GiB) available to be used for this project", - "name": "primarystorageavailable", - "type": "string" - }, - { - "description": "the total number of vpcs available to be created for this project", - "name": "vpcavailable", + "description": "the total number of cpu cores available to be created for this project", + "name": "cpuavailable", "type": "string" }, { - "description": "the displaytext of the project", - "name": "displaytext", - "type": "string" + "description": "the total number of virtual machines running for this project", + "name": "vmrunning", + "type": "integer" }, { - "description": "the total volume available for this project", - "name": "volumeavailable", + "description": "the total number of networks available to be created for this project", + "name": "networkavailable", "type": "string" }, { - "description": "the total memory (in MB) available to be created for this project", - "name": "memoryavailable", + "description": "the state of the project", + "name": "state", "type": "string" }, { - "description": "the total number of cpu cores available to be created for this project", - "name": "cpuavailable", + "description": "the total secondary storage space (in GiB) the project can own", + "name": "secondarystoragelimit", "type": "string" }, - {}, { - "description": "the total number of networks available to be created for this project", - "name": "networkavailable", + "description": "the total volume which can be used by this project", + "name": "volumelimit", "type": "string" }, { - "description": "the account name of the project's owners", - "name": "owner", - "type": "list" - }, - { - "description": "the id of the project", - "name": "id", - "type": "string" + "description": "the total number of vpcs owned by project", + "name": "vpctotal", + "type": "long" }, { "description": "the total number of snapshots stored by this project", @@ -96681,13 +98491,8 @@ "type": "long" }, { - "description": "the total primary storage space (in GiB) the project can own", - "name": "primarystoragelimit", - "type": "string" - }, - { - "description": "the total number of virtual machines deployed by this project", - "name": "vmtotal", + "description": "the total number of networks owned by project", + "name": "networktotal", "type": "long" }, { @@ -96696,19 +98501,25 @@ "type": "date" }, { - "description": "the total number of public ip addresses available for this project to acquire", - "name": "ipavailable", + "description": "the displaytext of the project", + "name": "displaytext", "type": "string" }, + {}, { - "description": "the total number of snapshots available for this project", - "name": "snapshotavailable", - "type": "string" + "description": "the total number of virtual machines stopped for this project", + "name": "vmstopped", + "type": "integer" }, { - "description": "the total secondary storage space (in GiB) the project can own", - "name": "secondarystoragelimit", - "type": "string" + "description": "the total primary storage space (in GiB) owned by project", + "name": "primarystoragetotal", + "type": "long" + }, + { + "description": "the total secondary storage space (in GiB) owned by project", + "name": "secondarystoragetotal", + "type": "float" }, { "description": "the name of the project", @@ -96716,123 +98527,186 @@ "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", + "type": "string" }, { - "description": "the total number of templates which have been created by this project", - "name": "templatetotal", - "type": "long" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the total memory (in MB) available to be created for this project", + "name": "memoryavailable", "type": "string" }, { - "description": "the total number of virtual machines stopped for this project", - "name": "vmstopped", - "type": "integer" + "description": "the account name of the project's owners", + "name": "owner", + "type": "list" }, + {}, { - "description": "the total number of vpcs the project can own", - "name": "vpclimit", + "description": "the list of resource tags associated with vm", + "name": "tags", + "response": [ + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + } + ], + "type": "list" + }, + { + "description": "the total number of networks the project can own", + "name": "networklimit", "type": "string" }, { - "description": "the total memory (in MB) the project can own", - "name": "memorylimit", + "description": "the project account name of the project", + "name": "projectaccountname", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the total number of cpu cores the project can own", + "name": "cpulimit", + "type": "string" }, { - "description": "the domain id the project belongs to", - "name": "domainid", + "description": "the domain name where the project belongs to", + "name": "domain", "type": "string" }, { - "description": "the total number of templates which can be created by this project", - "name": "templatelimit", + "description": "the total number of vpcs the project can own", + "name": "vpclimit", "type": "string" }, { - "description": "the total number of virtual machines available for this project to acquire", - "name": "vmavailable", + "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 volume being used by this project", + "name": "volumetotal", + "type": "long" }, { - "description": "the state of the project", - "name": "state", + "description": "the total number of templates which can be created by this project", + "name": "templatelimit", "type": "string" }, { - "description": "the total number of vpcs owned by project", - "name": "vpctotal", - "type": "long" + "description": "the total number of public ip addresses available for this project to acquire", + "name": "ipavailable", + "type": "string" }, { - "description": "the domain name where the project belongs to", - "name": "domain", + "description": "the total secondary storage space (in GiB) available to be used for this project", + "name": "secondarystorageavailable", "type": "string" }, { - "description": "the total primary storage space (in GiB) owned by project", - "name": "primarystoragetotal", + "description": "the total number of templates which have been created by this project", + "name": "templatetotal", "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 number of networks owned by project", - "name": "networktotal", + "description": "the total number of public ip addresses allocated for this project", + "name": "iptotal", "type": "long" }, { - "description": "the total number of snapshots which can be stored by this project", - "name": "snapshotlimit", + "description": "the total number of vpcs available to be created for this project", + "name": "vpcavailable", "type": "string" }, { - "description": "the total secondary storage space (in GiB) available to be used for this project", - "name": "secondarystorageavailable", + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the total number of public ip addresses this project can acquire", + "name": "iplimit", "type": "string" }, { - "description": "the total number of virtual machines running for this project", - "name": "vmrunning", - "type": "integer" + "description": "the total number of snapshots available for this project", + "name": "snapshotavailable", + "type": "string" }, { - "description": "the total volume being used by this project", - "name": "volumetotal", + "description": "the total number of virtual machines deployed by this project", + "name": "vmtotal", "type": "long" }, { - "description": "the total number of public ip addresses this project can acquire", - "name": "iplimit", + "description": "the total memory (in MB) the project can own", + "name": "memorylimit", "type": "string" }, { - "description": "the total number of networks the project can own", - "name": "networklimit", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the total memory (in MB) owned by project", - "name": "memorytotal", + "description": "the total number of cpu cores owned by project", + "name": "cputotal", "type": "long" }, { @@ -96841,81 +98715,33 @@ "type": "string" }, { - "description": "the total number of templates available to be created by this project", - "name": "templateavailable", + "description": "the total volume available for this project", + "name": "volumeavailable", "type": "string" }, { - "description": "the list of resource tags associated with vm", - "name": "tags", - "response": [ - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "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": "resource type", - "name": "resourcetype", - "type": "string" - } - ], - "type": "list" + "description": "the total primary storage space (in GiB) available to be used for this project", + "name": "primarystorageavailable", + "type": "string" }, - {}, { - "description": "the project account name of the project", - "name": "projectaccountname", + "description": "the total number of snapshots which can be stored by this project", + "name": "snapshotlimit", "type": "string" }, { - "description": "the total number of cpu cores owned by project", - "name": "cputotal", - "type": "long" + "description": "the domain id the project belongs to", + "name": "domainid", + "type": "string" }, { - "description": "the total volume which can be used by this project", - "name": "volumelimit", + "description": "the id of the project", + "name": "id", + "type": "string" + }, + { + "description": "the total number of templates available to be created by this project", + "name": "templateavailable", "type": "string" } ], @@ -96926,14 +98752,6 @@ "isasync": true, "name": "updateIpAddress", "params": [ - { - "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", - "length": 255, - "name": "customid", - "required": false, - "since": "4.4", - "type": "string" - }, { "description": "the ID of the public IP address to update", "length": 255, @@ -96949,88 +98767,87 @@ "required": false, "since": "4.4", "type": "boolean" + }, + { + "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", + "length": 255, + "name": "customid", + "required": false, + "since": "4.4", + "type": "string" } ], "related": "associateIpAddress,listPublicIpAddresses", "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": "is public ip for display to the regular user", - "name": "fordisplay", + "description": "true if this ip is system ip (was allocated as a part of deployVm or createLbRule)", + "name": "issystem", "type": "boolean" }, { - "description": "the domain the public IP address is associated with", - "name": "domain", - "type": "string" - }, - { - "description": "public IP address", - "name": "ipaddress", + "description": "the name of the Network where ip belongs to", + "name": "networkname", "type": "string" }, { - "description": "the VLAN associated with the IP address", - "name": "vlanname", + "description": "virtual machine (dnat) ip address (not null only for static nat Ip)", + "name": "vmipaddress", "type": "string" }, { - "description": "date the public IP address was acquired", - "name": "allocated", - "type": "date" + "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", + "description": "VPC name the ip belongs to", + "name": "vpcname", "type": "string" }, + {}, { - "description": "is public IP portable across the zones", - "name": "isportable", - "type": "boolean" + "description": "public IP address", + "name": "ipaddress", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "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", + "description": "the project name of the address", + "name": "project", "type": "string" }, { - "description": "State of the ip address. Can be: Allocatin, Allocated and Releasing", - "name": "state", + "description": "the domain ID the public IP address is associated with", + "name": "domainid", "type": "string" }, {}, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the project name of the address", - "name": "project", + "description": "virtual machine display name the ip address is assigned to (not null only for static nat Ip)", + "name": "virtualmachinedisplayname", "type": "string" }, { "description": "the list of resource tags associated with ip address", "name": "tags", "response": [ + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, { "description": "resource type", "name": "resourcetype", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { @@ -97044,107 +98861,111 @@ "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" } ], "type": "list" }, { - "description": "virtual machine name the ip address is assigned to (not null only for static nat Ip)", - "name": "virtualmachinename", + "description": "true if the IP address is a source nat address, false otherwise", + "name": "issourcenat", + "type": "boolean" + }, + { + "description": "the ID of the Network where ip belongs to", + "name": "networkid", "type": "string" }, { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "the domain the public IP address is associated with", + "name": "domain", "type": "string" }, { - "description": "the virtual network for the IP address", - "name": "forvirtualnetwork", - "type": "boolean" + "description": "VPC id the ip belongs to", + "name": "vpcid", + "type": "string" }, { - "description": "true if the IP address is a source nat address, false otherwise", - "name": "issourcenat", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", + "description": "the ID of the zone the public IP address belongs to", + "name": "zoneid", + "type": "string" + }, + { + "description": "virtual machine name the ip address is assigned to (not null only for static nat Ip)", + "name": "virtualmachinename", + "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", + "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": "VPC name the ip belongs to", - "name": "vpcname", + "description": "the ID of the Network associated with the IP address", + "name": "associatednetworkid", "type": "string" }, { - "description": "the name of the Network where ip belongs to", - "name": "networkname", - "type": "string" + "description": "is public ip for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, { - "description": "the domain ID the public IP address is associated with", - "name": "domainid", + "description": "the VLAN associated with the IP address", + "name": "vlanname", "type": "string" }, { - "description": "the ID of the Network where ip belongs to", - "name": "networkid", - "type": "string" + "description": "date the public IP address was acquired", + "name": "allocated", + "type": "date" }, - {}, { - "description": "the account the public IP address is associated with", - "name": "account", + "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 virtual network for the IP address", + "name": "forvirtualnetwork", + "type": "boolean" }, { - "description": "purpose of the IP address. In Acton this value is not null for Ips with isSystem=true, and can have either StaticNat or LB value", - "name": "purpose", + "description": "virtual machine id the ip address is assigned to (not null only for static nat Ip)", + "name": "virtualmachineid", "type": "string" }, { @@ -97153,13 +98974,13 @@ "type": "string" }, { - "description": "virtual machine id the ip address is assigned to (not null only for static nat Ip)", - "name": "virtualmachineid", - "type": "string" + "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", + "description": "the account the public IP address is associated with", + "name": "account", "type": "string" }, { @@ -97167,19 +98988,24 @@ "name": "id", "type": "string" }, + { + "description": "State of the ip address. Can be: Allocatin, Allocated and Releasing", + "name": "state", + "type": "string" + }, { "description": "the name of the zone the public IP address belongs to", "name": "zonename", "type": "string" }, { - "description": "true if this ip is for static nat, false otherwise", - "name": "isstaticnat", - "type": "boolean" + "description": "purpose of the IP address. In Acton this value is not null for Ips with isSystem=true, and can have either StaticNat or LB value", + "name": "purpose", + "type": "string" }, { - "description": "virtual machine (dnat) ip address (not null only for static nat Ip)", - "name": "vmipaddress", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" } ] @@ -97191,27 +99017,32 @@ "params": [], "related": "", "response": [ + { + "description": "the account name of the api remaining count", + "name": "account", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "currently allowed number of apis", "name": "apiAllowed", "type": "int" }, - {}, - {}, { "description": "the account uuid of the api remaining count", "name": "accountid", "type": "string" }, + {}, + {}, { - "description": "number of api already issued", - "name": "apiIssued", - "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", @@ -97219,14 +99050,9 @@ "type": "string" }, { - "description": "seconds left to reset counters", - "name": "expireAfter", - "type": "long" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "number of api already issued", + "name": "apiIssued", + "type": "int" } ] }, @@ -97251,9 +99077,9 @@ "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" }, {}, { @@ -97261,12 +99087,12 @@ "name": "success", "type": "boolean" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - } + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + }, + {} ], "since": "3.0.0" }, @@ -97276,11 +99102,12 @@ "name": "migrateNetwork", "params": [ { - "description": "true if previous network migration cmd failed", + "description": "the ID of the network", "length": 255, - "name": "resume", - "required": false, - "type": "boolean" + "name": "networkid", + "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork", + "required": true, + "type": "uuid" }, { "description": "network offering ID", @@ -97291,21 +99118,45 @@ "type": "uuid" }, { - "description": "the ID of the network", + "description": "true if previous network migration cmd failed", "length": 255, - "name": "networkid", - "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork,listF5LoadBalancerNetworks", - "required": true, - "type": "uuid" + "name": "resume", + "required": false, + "type": "boolean" } ], - "related": "createNetwork,updateNetwork,listNetworks,listF5LoadBalancerNetworks", + "related": "createNetwork,updateNetwork,listNetworks", "response": [ { "description": "state of the network", "name": "state", "type": "string" }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + }, + { + "description": "the ID of the Network associated with this network", + "name": "associatednetworkid", + "type": "string" + }, + { + "description": "list networks that are persistent", + "name": "ispersistent", + "type": "boolean" + }, + { + "description": "true if network offering is ip conserve mode enabled", + "name": "networkofferingconservemode", + "type": "boolean" + }, + { + "description": "the date this network was created", + "name": "created", + "type": "date" + }, { "description": "true if network supports specifying ip ranges, false otherwise", "name": "specifyipranges", @@ -97316,14 +99167,173 @@ "name": "networkofferingname", "type": "string" }, + { + "description": "the displaytext of the network", + "name": "displaytext", + "type": "string" + }, + {}, + { + "description": "ACL name associated with the VPC network", + "name": "aclname", + "type": "string" + }, + { + "description": "network offering id the network is created from", + "name": "networkofferingid", + "type": "string" + }, + { + "description": "display text of the network offering the network is created from", + "name": "networkofferingdisplaytext", + "type": "string" + }, + { + "description": "The routing mode of network offering", + "name": "ip6routing", + "type": "string" + }, + { + "description": "true if guest network default egress policy is allow; false if default egress policy is deny", + "name": "egressdefaultpolicy", + "type": "boolean" + }, + { + "description": "the network domain", + "name": "networkdomain", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + {}, + { + "description": "the domain id of the network owner", + "name": "domainid", + "type": "string" + }, + { + "description": "the ID of the Network associated with this private gateway", + "name": "associatednetworkid", + "type": "string" + }, + { + "description": "the physical network id", + "name": "physicalnetworkid", + "type": "string" + }, + { + "description": "the traffic type of the network", + "name": "traffictype", + "type": "string" + }, + { + "description": "Name of the VPC to which this network belongs", + "name": "vpcname", + "type": "string" + }, + { + "description": "VPC the network belongs to", + "name": "vpcid", + "type": "string" + }, + { + "description": "true if users from subdomains can access the domain level network", + "name": "subdomainaccess", + "type": "boolean" + }, + { + "description": "The internet protocol of network offering", + "name": "internetprotocol", + "type": "string" + }, + { + "description": "availability of the network offering the network is created from", + "name": "networkofferingavailability", + "type": "string" + }, + { + "description": "the name of the network", + "name": "name", + "type": "string" + }, + { + "description": "the list of resource tags associated with network", + "name": "tags", + "response": [ + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + } + ], + "type": "list" + }, + { + "description": "the name of the zone the network belongs to", + "name": "zonename", + "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", + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" + }, + { + "description": "related to what other network configuration", + "name": "related", "type": "string" }, { @@ -97332,37 +99342,64 @@ "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 vlan of the network. This parameter is visible to ROOT admins only", + "name": "vlan", + "type": "string" + }, + { + "description": "true if network is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "the id of the network", + "name": "id", + "type": "string" }, { "description": "the list of services", "name": "service", "response": [ { - "description": "the service provider name", - "name": "provider", + "description": "the list of capabilities", + "name": "capability", "response": [ { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", + "description": "the capability name", + "name": "name", "type": "string" }, { - "description": "uuid of the network provider", - "name": "id", + "description": "the capability value", + "name": "value", "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" + } + ], + "type": "list" + }, + { + "description": "the service provider name", + "name": "provider", + "response": [ + { + "description": "the provider name", + "name": "name", "type": "string" }, { - "description": "services for this provider", - "name": "servicelist", - "type": "list" + "description": "the physical network this belongs to", + "name": "physicalnetworkid", + "type": "string" }, { "description": "true if individual services can be enabled/disabled", @@ -97375,8 +99412,18 @@ "type": "string" }, { - "description": "the provider name", - "name": "name", + "description": "services for this provider", + "name": "servicelist", + "type": "list" + }, + { + "description": "uuid of the network provider", + "name": "id", + "type": "string" + }, + { + "description": "state of the network provider", + "name": "state", "type": "string" } ], @@ -97386,46 +99433,28 @@ "description": "the service name", "name": "name", "type": "string" - }, - { - "description": "the list of capabilities", - "name": "capability", - "response": [ - { - "description": "the capability value", - "name": "value", - "type": "string" - }, - { - "description": "the capability name", - "name": "name", - "type": "string" - }, - { - "description": "can this service capability value can be choosable while creatine network offerings", - "name": "canchooseservicecapability", - "type": "boolean" - } - ], - "type": "list" } ], "type": "list" }, { - "description": "the network's netmask", - "name": "netmask", + "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 external id of the network", + "name": "externalid", "type": "string" }, - {}, { - "description": "the domain id of the network owner", - "name": "domainid", + "description": "true if network is system, false otherwise", + "name": "issystem", + "type": "boolean" + }, + { + "description": "the name of the Network associated with this private gateway", + "name": "associatednetwork", "type": "string" }, { @@ -97434,39 +99463,113 @@ "type": "string" }, { - "description": "VPC the network belongs to", - "name": "vpcid", + "description": "the network CIDR of the guest network configured with IP reservation. It is the summation of CIDR and RESERVED_IP_RANGE", + "name": "networkcidr", "type": "string" }, { - "description": "Name of the VPC to which this network belongs", - "name": "vpcname", + "description": "true network requires restart", + "name": "restartrequired", + "type": "boolean" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" + }, + { + "description": "an optional field, whether to the display the network to the end user or not.", + "name": "displaynetwork", + "type": "boolean" + }, + { + "description": "If a network is enabled for 'streched l2 subnet' then represents zones on which network currently spans", + "name": "zonesnetworkspans", + "type": "set" + }, + { + "description": "the domain name of the network owner", + "name": "domain", + "type": "string" + }, + { + "description": "ACL Id associated with the VPC network", + "name": "aclid", + "type": "string" + }, + { + "description": "list networks available for vm deployment", + "name": "canusefordeploy", + "type": "boolean" + }, + { + "description": "Broadcast domain type of the network", + "name": "broadcastdomaintype", + "type": "string" + }, + { + "description": "the type of the network", + "name": "type", + "type": "string" + }, + { + "description": "If the network has redundant routers enabled", + "name": "redundantrouter", + "type": "boolean" + }, + { + "description": "the owner of the network", + "name": "account", + "type": "string" + }, + { + "description": "the name of the Network associated with this network", + "name": "associatednetwork", + "type": "string" + }, + { + "description": "the network's IP range not to be used by CloudStack guest VMs and can be used for non CloudStack purposes", + "name": "reservediprange", + "type": "string" + }, + { + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" + }, + { + "description": "the network's netmask", + "name": "netmask", + "type": "string" + }, + { + "description": "acl type - access type to the network", + "name": "acltype", "type": "string" }, { - "description": "If the network has redundant routers enabled", - "name": "redundantrouter", - "type": "boolean" + "description": "the project name of the address", + "name": "project", + "type": "string" }, { - "description": "network offering id the network is created from", - "name": "networkofferingid", - "type": "string" + "description": "the details of the network", + "name": "details", + "type": "map" }, { - "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 project name of the address", - "name": "project", - "type": "string" + "description": "true if network can span multiple zones", + "name": "strechedl2subnet", + "type": "boolean" }, { - "description": "availability of the network offering the network is created from", - "name": "networkofferingavailability", + "description": "the first DNS for the network", + "name": "dns1", "type": "string" }, { @@ -97475,182 +99578,266 @@ "type": "resourceiconresponse" }, { - "description": "the name of the network", - "name": "name", + "description": "the second DNS for the network", + "name": "dns2", "type": "string" }, { - "description": "the domain name of the network owner", - "name": "domain", - "type": "string" + "description": "The routes for the network to ease adding route in upstream router", + "name": "ip6routes", + "type": "set" }, { - "description": "related to what other network configuration", - "name": "related", + "description": "the project id of the ipaddress", + "name": "projectid", "type": "string" - }, - { - "description": "an optional field, whether to the display the network to the end user or not.", - "name": "displaynetwork", - "type": "boolean" - }, + } + ], + "since": "4.11.0" + }, + { + "description": "Adds a VMware datacenter to specified zone", + "isasync": false, + "name": "addVmwareDc", + "params": [ { - "description": "the name of the zone the network belongs to", - "name": "zonename", + "description": "Name of VMware datacenter to be added to specified zone.", + "length": 255, + "name": "name", + "required": true, "type": "string" }, { - "description": "the network domain", - "name": "networkdomain", + "description": "The password for specified username.", + "length": 255, + "name": "password", + "required": false, "type": "string" }, { - "description": "the traffic type of the network", - "name": "traffictype", + "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": "display text of the network offering the network is created from", - "name": "networkofferingdisplaytext", + "description": "The Username required to connect to resource.", + "length": 255, + "name": "username", + "required": false, "type": "string" }, { - "description": "list networks available for vm deployment", - "name": "canusefordeploy", - "type": "boolean" - }, + "description": "The Zone ID.", + "length": 255, + "name": "zoneid", + "related": "createZone,listZones", + "required": true, + "type": "uuid" + } + ], + "related": "", + "response": [ { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "The VMware vCenter name/ip", + "name": "vcenter", "type": "string" }, + {}, { - "description": "true if network is system, false otherwise", - "name": "issystem", - "type": "boolean" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the details of the network", - "name": "details", - "type": "map" + "description": "the Zone ID associated with this VMware Datacenter", + "name": "zoneid", + "type": "long" }, { - "description": "true if users from subdomains can access the domain level network", - "name": "subdomainaccess", - "type": "boolean" + "description": "The VMware Datacenter ID", + "name": "id", + "type": "string" }, { - "description": "true if network can span multiple zones", - "name": "strechedl2subnet", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "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 VMware Datacenter name", + "name": "name", "type": "string" }, + {} + ] + }, + { + "description": "Updates Ipv6 firewall rule with specified ID", + "isasync": true, + "name": "updateIpv6FirewallRule", + "params": [ { - "description": "Broadcast domain type of the network", - "name": "broadcastdomaintype", - "type": "string" + "description": "the ending port of Ipv6 firewall rule", + "length": 255, + "name": "endport", + "required": false, + "type": "integer" }, { - "description": "true network requires restart", - "name": "restartrequired", - "type": "boolean" + "description": "the cidr list to allow traffic from/to. Multiple entries must be separated by a single comma character (,).", + "length": 255, + "name": "cidrlist", + "required": false, + "type": "list" }, { - "description": "the project id of the ipaddress", - "name": "projectid", - "type": "string" + "description": "error code for this ICMP message", + "length": 255, + "name": "icmpcode", + "required": false, + "type": "integer" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the starting port of Ipv6 firewall rule", + "length": 255, + "name": "startport", + "required": false, + "type": "integer" }, { - "description": "the physical network id", - "name": "physicalnetworkid", + "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 vlan of the network. This parameter is visible to ROOT admins only", - "name": "vlan", + "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": "If a network is enabled for 'streched l2 subnet' then represents zones on which network currently spans", - "name": "zonesnetworkspans", - "type": "set" - }, - { - "description": "acl type - access type to the network", - "name": "acltype", + "description": "the 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": "list networks that are persistent", - "name": "ispersistent", + "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 type of the network", - "name": "type", + "description": "type of the ICMP message being sent", + "length": 255, + "name": "icmptype", + "required": false, + "type": "integer" + }, + { + "description": "the ID of the ipv6 firewall rule", + "length": 255, + "name": "id", + "related": "updateIpv6FirewallRule", + "required": true, + "type": "uuid" + } + ], + "related": "", + "response": [ + { + "description": "the public ip address for the port forwarding rule", + "name": "ipaddress", "type": "string" }, + {}, { - "description": "the id of the network", + "description": "the ID of the port forwarding rule", "name": "id", "type": "string" }, { - "description": "the displaytext of the network", - "name": "displaytext", + "description": "the ending port of port forwarding rule's private port range", + "name": "privateendport", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "the starting port of port forwarding rule's public port range", + "name": "publicport", "type": "string" }, { - "description": "ACL Id associated with the VPC network", - "name": "aclid", + "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 owner of the network", - "name": "account", + "description": "the public ip address id for the port forwarding rule", + "name": "ipaddressid", "type": "string" }, { - "description": "true if network offering is ip conserve mode enabled", - "name": "networkofferingconservemode", + "description": "the starting port of port forwarding rule's private port range", + "name": "privateport", + "type": "string" + }, + { + "description": "the state of the rule", + "name": "state", + "type": "string" + }, + { + "description": "the protocol of the port forwarding rule", + "name": "protocol", + "type": "string" + }, + { + "description": "is firewall for display to the regular user", + "name": "fordisplay", "type": "boolean" }, { - "description": "The external id of the network", - "name": "externalid", + "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", "type": "string" }, { - "description": "the list of resource tags associated with network", + "description": "the VM display name for the port forwarding rule", + "name": "virtualmachinedisplayname", + "type": "string" + }, + { + "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "tag key name", - "name": "key", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { @@ -97664,18 +99851,13 @@ "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": "id of the resource", - "name": "resourceid", + "description": "tag key name", + "name": "key", "type": "string" }, { @@ -97684,98 +99866,21 @@ "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the account associated with the tag", + "name": "account", "type": "string" } ], "type": "list" }, { - "description": "the first DNS for the network", - "name": "dns1", - "type": "string" - }, - { - "description": "true if network is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "the second DNS for the network", - "name": "dns2", - "type": "string" - }, - { - "description": "ACL name associated with the VPC network", - "name": "aclname", - "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 date this network was created", - "name": "created", - "type": "date" - } - ], - "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": "The Username required to connect to resource.", - "length": 255, - "name": "username", - "required": false, - "type": "string" - }, - { - "description": "Name of VMware datacenter to be added to specified zone.", - "length": 255, - "name": "name", - "required": true, - "type": "string" - } - ], - "related": "", - "response": [ - { - "description": "The VMware Datacenter name", - "name": "name", + "description": "the id of the guest network the port forwarding rule belongs to", + "name": "networkid", "type": "string" }, { @@ -97783,28 +99888,21 @@ "name": "jobid", "type": "string" }, - {}, - { - "description": "the Zone ID associated with this VMware Datacenter", - "name": "zoneid", - "type": "long" - }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the ending port of port forwarding rule's private port range", + "name": "publicendport", + "type": "string" }, { - "description": "The VMware vCenter name/ip", - "name": "vcenter", + "description": "the VM ID for the port forwarding rule", + "name": "virtualmachineid", "type": "string" }, { - "description": "The VMware Datacenter ID", - "name": "id", + "description": "the VM name for the port forwarding rule", + "name": "virtualmachinename", "type": "string" - }, - {} + } ] }, { @@ -97815,7 +99913,7 @@ { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, @@ -97826,17 +99924,10 @@ "required": false, "type": "string" }, - { - "description": "the hypervisor name of the instance", - "length": 255, - "name": "name", - "required": false, - "type": "string" - }, { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, @@ -97847,82 +99938,146 @@ "related": "addCluster", "required": true, "type": "uuid" + }, + { + "description": "the hypervisor name of the instance", + "length": 255, + "name": "name", + "required": false, + "type": "string" } ], "related": "", "response": [ { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the memory of the virtual machine in MB", - "name": "memory", - "type": "integer" - }, - { - "description": "the list of nics associated with the virtual machine", - "name": "nic", + "description": "the list of disks associated with the virtual machine", + "name": "disk", "response": [ { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "the file path of the disk image", + "name": "imagepath", "type": "string" }, { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "description": "the controller of the disk", + "name": "datastorehost", "type": "string" }, { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "the controller unit of the disk", + "name": "controllerunit", + "type": "integer" + }, + { + "description": "the controller of the disk", + "name": "datastoretype", "type": "string" }, { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "the label of the disk", + "name": "label", + "type": "string" + }, + { + "description": "the capacity of the disk in bytes", + "name": "capacity", + "type": "long" + }, + { + "description": "the position of the disk", + "name": "position", + "type": "integer" + }, + { + "description": "the controller of the disk", + "name": "datastorepath", + "type": "string" + }, + { + "description": "the controller of the disk", + "name": "datastorename", "type": "string" }, + { + "description": "the ID of the disk", + "name": "id", + "type": "string" + }, + { + "description": "the controller of the disk", + "name": "controller", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the CPU cores of the virtual machine", + "name": "cpunumber", + "type": "integer" + }, + { + "description": "the CPU speed of the virtual machine", + "name": "cpuspeed", + "type": "integer" + }, + { + "description": "the ID of the cluster to which virtual machine belongs", + "name": "clusterid", + "type": "string" + }, + { + "description": "the ID of the host to which virtual machine belongs", + "name": "hostid", + "type": "string" + }, + { + "description": "the operating system ID of the virtual machine", + "name": "osid", + "type": "string" + }, + { + "description": "the list of nics associated with the virtual machine", + "name": "nic", + "response": [ { "description": "the ID of the nic", "name": "id", "type": "string" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", - "type": "string" + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" }, { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "description": "the ip address of the nic", + "name": "ipaddress", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "the name of the corresponding network", + "name": "networkname", "type": "string" }, { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" + "description": "the traffic type of the nic", + "name": "traffictype", + "type": "string" }, { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "the gateway of the nic", + "name": "gateway", "type": "string" }, { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", + "type": "string" }, { - "description": "the IPv6 address of network", - "name": "ip6address", + "description": "true if nic is default, false otherwise", + "name": "macaddress", "type": "string" }, { @@ -97931,8 +100086,8 @@ "type": "string" }, { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { @@ -97941,14 +100096,14 @@ "type": "boolean" }, { - "description": "the gateway of the nic", - "name": "gateway", + "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": "ID of the VLAN/VNI if available", @@ -97956,128 +100111,81 @@ "type": "integer" }, { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "description": "the type of the nic", - "name": "type", - "type": "string" - }, - { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "the ID of the corresponding network", + "name": "networkid", "type": "string" }, { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", + "description": "the isolation uri of the nic", + "name": "isolationuri", "type": "string" }, { - "description": "the netmask of the nic", - "name": "netmask", + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "type": "string" }, { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", "type": "string" }, { - "description": "the ip address of the nic", - "name": "ipaddress", - "type": "string" + "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 operating system ID of the virtual machine", - "name": "osid", - "type": "string" - }, - { - "description": "the list of disks associated with the virtual machine", - "name": "disk", - "response": [ - { - "description": "the controller of the disk", - "name": "datastorehost", - "type": "string" + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" }, { - "description": "the capacity of the disk in bytes", - "name": "capacity", - "type": "long" + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" }, { - "description": "the file path of the disk image", - "name": "imagepath", + "description": "the IPv6 address of network", + "name": "ip6address", "type": "string" }, { - "description": "the controller of the disk", - "name": "controller", + "description": "the type of the nic", + "name": "type", "type": "string" }, { - "description": "the controller of the disk", - "name": "datastorepath", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "the controller of the disk", - "name": "datastoretype", + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", "type": "string" }, { - "description": "the ID of the disk", - "name": "id", + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", "type": "string" }, { - "description": "the label of the disk", - "name": "label", + "description": "the netmask of the nic", + "name": "netmask", "type": "string" }, { - "description": "the controller of the disk", - "name": "datastorename", + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", "type": "string" - }, - { - "description": "the position of the disk", - "name": "position", - "type": "integer" - }, - { - "description": "the controller unit of the disk", - "name": "controllerunit", - "type": "integer" } ], "type": "set" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the power state of the virtual machine", - "name": "powerstate", - "type": "string" - }, - { - "description": "the CPU speed of the virtual machine", - "name": "cpuspeed", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { @@ -98086,37 +100194,37 @@ "type": "string" }, { - "description": "the ID of the host to which virtual machine belongs", - "name": "hostid", + "description": "the power state of the virtual machine", + "name": "powerstate", "type": "string" }, { - "description": "the CPU cores per socket for the virtual machine. VMware specific", - "name": "cpucorepersocket", + "description": "the memory of the virtual machine in MB", + "name": "memory", "type": "integer" }, { - "description": "the ID of the cluster to which virtual machine belongs", - "name": "clusterid", - "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", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - { - "description": "the CPU cores of the virtual machine", - "name": "cpunumber", - "type": "integer" - }, - {}, { "description": "the name of the virtual machine", "name": "name", "type": "string" }, - {} + { + "description": "the operating system of the virtual machine", + "name": "osdisplayname", + "type": "string" + } ], "since": "4.14.0" }, @@ -98125,14 +100233,6 @@ "isasync": false, "name": "updateIsoPermissions", "params": [ - { - "description": "the template ID", - "length": 255, - "name": "id", - "related": "registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", - "required": true, - "type": "uuid" - }, { "description": "true for featured template/iso, false otherwise", "length": 255, @@ -98141,18 +100241,11 @@ "type": "boolean" }, { - "description": "permission operator (add, remove, reset)", - "length": 255, - "name": "op", - "required": false, - "type": "string" - }, - { - "description": "a comma delimited list of accounts within caller's domain. If specified, \"op\" parameter has to be passed in.", + "description": "true for public template/iso, false for private templates/isos", "length": 255, - "name": "accounts", + "name": "ispublic", "required": false, - "type": "list" + "type": "boolean" }, { "description": "a comma delimited list of projects. If specified, \"op\" parameter has to be passed in.", @@ -98163,11 +100256,11 @@ "type": "list" }, { - "description": "true for public template/iso, false for private templates/isos", + "description": "a comma delimited list of accounts within caller's domain. If specified, \"op\" parameter has to be passed in.", "length": 255, - "name": "ispublic", + "name": "accounts", "required": false, - "type": "boolean" + "type": "list" }, { "description": "true if the template/iso is extractable, false other wise. Can be set only by root admin", @@ -98175,19 +100268,33 @@ "name": "isextractable", "required": false, "type": "boolean" + }, + { + "description": "permission operator (add, remove, reset)", + "length": 255, + "name": "op", + "required": false, + "type": "string" + }, + { + "description": "the template ID", + "length": 255, + "name": "id", + "related": "registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", + "required": true, + "type": "uuid" } ], "response": [ - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, { "description": "any text associated with the success or failure", @@ -98195,10 +100302,11 @@ "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" }, + {}, {} ] }, @@ -98208,9 +100316,9 @@ "name": "registerTemplate", "params": [ { - "description": "the checksum value of this template. The parameter containing the checksum will be considered a MD5sum if it is not prefixed\n and just a plain ascii/utf8 representation of a hexadecimal string. If it is required to\n use another algorithm the hexadecimal string is to be prefixed with a string of the form,\n \"{}\", not including the double quotes. In this is the exact string\n representing the java supported algorithm, i.e. MD5 or SHA-256. Note that java does not\n contain an algorithm called SHA256 or one called sha-256, only SHA-256.", + "description": "the tag for this template.", "length": 255, - "name": "checksum", + "name": "templatetag", "required": false, "type": "string" }, @@ -98222,25 +100330,10 @@ "type": "boolean" }, { - "description": "the URL of where the template is hosted. Possible URL include http:// and https://", - "length": 2048, - "name": "url", - "required": true, - "type": "string" - }, - { - "description": "the format for the template. Possible values include QCOW2, RAW, VHD and OVA.", - "length": 255, - "name": "format", - "required": true, - "type": "string" - }, - { - "description": "(VMware only) true if VM deployments should preserve all the configurations defined for this template", + "description": "true if the template supports the password reset feature; default is false", "length": 255, - "name": "deployasis", + "name": "passwordenabled", "required": false, - "since": "4.15.1", "type": "boolean" }, { @@ -98259,26 +100352,47 @@ "type": "uuid" }, { - "description": "true if the template supports the password reset feature; default is false", + "description": "the name of the template", "length": 255, - "name": "passwordenabled", + "name": "name", + "required": true, + "type": "string" + }, + { + "description": "the checksum value of this template. The parameter containing the checksum will be considered a MD5sum if it is not prefixed\n and just a plain ascii/utf8 representation of a hexadecimal string. If it is required to\n use another algorithm the hexadecimal string is to be prefixed with a string of the form,\n \"{}\", not including the double quotes. In this is the exact string\n representing the java supported algorithm, i.e. MD5 or SHA-256. Note that java does not\n contain an algorithm called SHA256 or one called sha-256, only SHA-256.", + "length": 255, + "name": "checksum", + "required": false, + "type": "string" + }, + { + "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", + "length": 255, + "name": "isdynamicallyscalable", "required": false, "type": "boolean" }, { - "description": "the tag for this template.", + "description": "true if the template is available to all accounts; default is true", "length": 255, - "name": "templatetag", + "name": "ispublic", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "A list of zone ids where the template will be hosted. Use this parameter if the template needs to be registered to multiple zones in one go. Use zoneid if the template needs to be registered to only one zone.Passing only -1 to this will cause the template to be registered as a cross zone template and will be copied to all zones. ", + "description": "an optional domainId. If the account parameter is used, domainId must also be used.", "length": 255, - "name": "zoneids", - "related": "createZone,listZones", + "name": "domainid", + "related": "listDomainChildren,listDomains", "required": false, - "type": "list" + "type": "uuid" + }, + { + "description": "the display text of the template. This is usually used for display purposes.", + "length": 4096, + "name": "displaytext", + "required": true, + "type": "string" }, { "description": "Template details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].hypervisortoolsversion=xenserver61", @@ -98288,24 +100402,25 @@ "type": "map" }, { - "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", + "description": "true if the template supports the sshkey upload feature; default is false", "length": 255, - "name": "isdynamicallyscalable", + "name": "sshkeyenabled", "required": false, "type": "boolean" }, { - "description": "true if the template supports the sshkey upload feature; default is false", + "description": "an optional accountName. Must be used with domainId.", "length": 255, - "name": "sshkeyenabled", + "name": "account", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "true if this template is a featured template, false otherwise", + "description": "(VMware only) true if VM deployments should preserve all the configurations defined for this template", "length": 255, - "name": "isfeatured", + "name": "deployasis", "required": false, + "since": "4.15.1", "type": "boolean" }, { @@ -98316,40 +100431,33 @@ "type": "integer" }, { - "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 target hypervisor for the template", + "description": "the format for the template. Possible values include QCOW2, RAW, VHD and OVA.", "length": 255, - "name": "hypervisor", + "name": "format", "required": true, "type": "string" }, { - "description": "true if the template is available to all accounts; default is true", + "description": "true if this template requires HVM", "length": 255, - "name": "ispublic", + "name": "requireshvm", "required": false, "type": "boolean" }, { - "description": "the name of the template", + "description": "Register template for the project", "length": 255, - "name": "name", - "required": true, - "type": "string" + "name": "projectid", + "related": "activateProject", + "required": false, + "type": "uuid" }, { - "description": "the display text of the template. This is usually used for display purposes.", - "length": 4096, - "name": "displaytext", - "required": true, - "type": "string" + "description": "true if this template is a featured template, false otherwise", + "length": 255, + "name": "isfeatured", + "required": false, + "type": "boolean" }, { "description": "true if the template or its derivatives are extractable; default is false", @@ -98359,17 +100467,17 @@ "type": "boolean" }, { - "description": "true if this template requires HVM", + "description": "the target hypervisor for the template", "length": 255, - "name": "requireshvm", - "required": false, - "type": "boolean" + "name": "hypervisor", + "required": true, + "type": "string" }, { - "description": "an optional accountName. Must be used with domainId.", - "length": 255, - "name": "account", - "required": false, + "description": "the URL of where the template is hosted. Possible URL include http:// and https://", + "length": 2048, + "name": "url", + "required": true, "type": "string" }, { @@ -98381,30 +100489,20 @@ "type": "uuid" }, { - "description": "Register template for the project", + "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": "projectid", - "related": "activateProject", + "name": "zoneids", + "related": "createZone,listZones", "required": false, - "type": "uuid" + "type": "list" } ], "related": "listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", "response": [ { - "description": "the template name", - "name": "name", - "type": "string" - }, - { - "description": "the name of the secondary storage host for the template", - "name": "hostname", - "type": "string" - }, - { - "description": "the name of the zone for this template", - "name": "zonename", - "type": "string" + "description": "VMware only: additional key/value details tied with deploy-as-is template", + "name": "deployasisdetails", + "type": "map" }, { "description": "the date this template was removed", @@ -98412,8 +100510,8 @@ "type": "date" }, { - "description": "the ID of the zone for this template", - "name": "zoneid", + "description": "the project name of the template", + "name": "project", "type": "string" }, { @@ -98422,99 +100520,84 @@ "type": "string" }, { - "description": "VMware only: additional key/value details tied with deploy-as-is template", - "name": "deployasisdetails", - "type": "map" - }, - { - "description": "true if the template is managed across all Zones, false otherwise", - "name": "crossZones", - "type": "boolean" - }, - { - "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", - "name": "directdownload", - "type": "boolean" + "description": "the size of the template", + "name": "size", + "type": "long" }, { - "description": "true if the template is ready to be deployed from, false otherwise.", - "name": "isready", - "type": "boolean" + "description": "the name of the secondary storage host for the template", + "name": "hostname", + "type": "string" }, { - "description": "the physical size of the template", - "name": "physicalsize", - "type": "long" + "description": "if Datadisk template, then id of the root disk template this template belongs to", + "name": "parenttemplateid", + "type": "string" }, - {}, { - "description": "the URL which the template/iso is registered from", - "name": "url", + "description": "the template ID of the parent template if present", + "name": "sourcetemplateid", "type": "string" }, { - "description": "the processor bit size", - "name": "bits", - "type": "int" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the tag of this template", - "name": "templatetag", + "description": "the ID of the zone for this template", + "name": "zoneid", "type": "string" }, { - "description": "additional key/value details tied with template", - "name": "details", - "type": "map" + "description": "true if the ISO is bootable, false otherwise", + "name": "bootable", + "type": "boolean" }, { "description": "the project id of the template", "name": "projectid", "type": "string" }, - { - "description": "Lists the download progress of a template across all secondary storages", - "name": "downloaddetails", - "type": "list" - }, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "true if the template is extractable, false otherwise", - "name": "isextractable", - "type": "boolean" - }, - { - "description": "the template ID of the parent template if present", - "name": "sourcetemplateid", + "description": "the account id to which the template belongs", + "name": "accountid", "type": "string" }, { - "description": "true if template requires HVM enabled, false otherwise", - "name": "requireshvm", - "type": "boolean" + "description": "the format of the template.", + "name": "format", + "type": "imageformat" }, { - "description": "the template display text", - "name": "displaytext", + "description": "the status of the template", + "name": "status", "type": "string" }, { - "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", - "name": "isdynamicallyscalable", + "description": "true if the reset password feature is enabled, false otherwise", + "name": "passwordenabled", "type": "boolean" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", - "type": "string" + "description": "true if template requires HVM enabled, false otherwise", + "name": "requireshvm", + "type": "boolean" }, { - "description": "the ID of the OS type for this template.", - "name": "ostypeid", + "description": "true if this template is a featured template, false otherwise", + "name": "isfeatured", + "type": "boolean" + }, + { + "description": "the name of the OS type for this template.", + "name": "ostypename", "type": "string" }, { @@ -98523,41 +100606,41 @@ "type": "boolean" }, { - "description": "the format of the template.", - "name": "format", - "type": "imageformat" - }, - { - "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": "the size of the template", - "name": "size", - "type": "long" - }, - {}, - { - "description": "the type of the template", - "name": "templatetype", + "description": "the ID of the secondary storage host for the template", + "name": "hostid", "type": "string" }, { - "description": "the account name to which the template belongs", - "name": "account", + "description": "the ID of the OS type for this template.", + "name": "ostypeid", "type": "string" }, { - "description": "the project name of the template", - "name": "project", - "type": "string" + "description": "if root disk template, then ids of the datas disk templates this template owns", + "name": "childtemplates", + "type": "set" }, + {}, { - "description": "true if this template is a public template, false otherwise", - "name": "ispublic", + "description": "the date this template was created", + "name": "created", + "type": "date" + }, + { + "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 list of resource tags associated", "name": "tags", @@ -98568,13 +100651,8 @@ "type": "string" }, { - "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" }, { @@ -98587,11 +100665,6 @@ "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", @@ -98603,41 +100676,71 @@ "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { "description": "resource type", "name": "resourcetype", "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" } ], "type": "set" }, { - "description": "if Datadisk template, then id of the root disk template this template belongs to", - "name": "parenttemplateid", + "description": "the processor bit size", + "name": "bits", + "type": "int" + }, + { + "description": "the type of the template", + "name": "templatetype", "type": "string" }, { - "description": "checksum of the template", - "name": "checksum", + "description": "the URL which the template/iso is registered from", + "name": "url", "type": "string" }, { - "description": "true if the ISO is bootable, false otherwise", - "name": "bootable", + "description": "the physical size of the template", + "name": "physicalsize", + "type": "long" + }, + { + "description": "VMware only: true if template is deployed without orchestrating disks and networks but \"as-is\" defined in the template.", + "name": "deployasis", "type": "boolean" }, { - "description": "the account id to which the template belongs", - "name": "accountid", + "description": "the tag of this template", + "name": "templatetag", "type": "string" }, { - "description": "the ID of the secondary storage host for the template", - "name": "hostid", + "description": "the template ID", + "name": "id", + "type": "string" + }, + { + "description": "additional key/value details tied with template", + "name": "details", + "type": "map" + }, + { + "description": "the ID of the domain to which the template belongs", + "name": "domainid", "type": "string" }, { @@ -98646,53 +100749,58 @@ "type": "boolean" }, { - "description": "the date this template was created", - "name": "created", - "type": "date" + "description": "true if the template is managed across all Zones, false otherwise", + "name": "crossZones", + "type": "boolean" }, { - "description": "the status of the template", - "name": "status", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "if root disk template, then ids of the datas disk templates this template owns", - "name": "childtemplates", - "type": "set" + "description": "the name of the zone for this template", + "name": "zonename", + "type": "string" }, { - "description": "true if this template is a featured template, false otherwise", - "name": "isfeatured", + "description": "true if this template is a public template, false otherwise", + "name": "ispublic", "type": "boolean" }, { - "description": "the name of the OS type for this template.", - "name": "ostypename", + "description": "checksum of the template", + "name": "checksum", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "true if the reset password feature is enabled, false otherwise", - "name": "passwordenabled", + "description": "true if template 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": "the template name", + "name": "name", + "type": "string" }, { - "description": "the ID of the domain to which the template belongs", - "name": "domainid", + "description": "the template display text", + "name": "displaytext", "type": "string" }, { - "description": "the template ID", - "name": "id", + "description": "true if the template is ready to be deployed from, false otherwise.", + "name": "isready", + "type": "boolean" + }, + { + "description": "Lists the download progress of a template across all secondary storages", + "name": "downloaddetails", + "type": "list" + }, + { + "description": "the account name to which the template belongs", + "name": "account", "type": "string" } ] @@ -98712,27 +100820,27 @@ } ], "response": [ + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, {}, - {}, - { - "description": "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" } ] }, @@ -98742,9 +100850,9 @@ "name": "addStratosphereSsp", "params": [ { - "description": "stratosphere ssp server url", + "description": "stratosphere ssp api name", "length": 255, - "name": "url", + "name": "name", "required": true, "type": "string" }, @@ -98756,10 +100864,10 @@ "type": "string" }, { - "description": "stratosphere ssp api username", + "description": "stratosphere ssp server url", "length": 255, - "name": "username", - "required": false, + "name": "url", + "required": true, "type": "string" }, { @@ -98771,17 +100879,17 @@ "type": "uuid" }, { - "description": "stratosphere ssp tenant uuid", + "description": "stratosphere ssp api username", "length": 255, - "name": "tenantuuid", + "name": "username", "required": false, "type": "string" }, { - "description": "stratosphere ssp api name", + "description": "stratosphere ssp tenant uuid", "length": 255, - "name": "name", - "required": true, + "name": "tenantuuid", + "required": false, "type": "string" } ], @@ -98793,8 +100901,13 @@ "type": "integer" }, { - "description": "url of ssp endpoint", - "name": "url", + "description": "zone which this ssp controls", + "name": "zoneid", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, {}, @@ -98810,13 +100923,8 @@ "type": "string" }, { - "description": "zone which this ssp controls", - "name": "zoneid", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "url of ssp endpoint", + "name": "url", "type": "string" } ] @@ -98836,15 +100944,16 @@ } ], "response": [ + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -98852,7 +100961,6 @@ "name": "success", "type": "boolean" }, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", @@ -98866,9 +100974,17 @@ "name": "createStoragePool", "params": [ { - "description": "the storage provider name", + "description": "the Zone ID for the storage pool", "length": 255, - "name": "provider", + "name": "zoneid", + "related": "createZone,listZones", + "required": true, + "type": "uuid" + }, + { + "description": "the tags for the storage pool", + "length": 255, + "name": "tags", "required": false, "type": "string" }, @@ -98888,24 +101004,23 @@ "type": "long" }, { - "description": "the Zone ID for the storage pool", + "description": "the scope of the storage: cluster or zone", "length": 255, - "name": "zoneid", - "related": "createZone,listZones", - "required": true, - "type": "uuid" + "name": "scope", + "required": false, + "type": "string" }, { - "description": "the name for the storage pool", + "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": "name", - "required": true, + "name": "hypervisor", + "required": false, "type": "string" }, { - "description": "the tags for the storage pool", + "description": "the storage provider name", "length": 255, - "name": "tags", + "name": "provider", "required": false, "type": "string" }, @@ -98917,11 +101032,11 @@ "type": "boolean" }, { - "description": "the details for the storage pool", + "description": "the name for the storage pool", "length": 255, - "name": "details", - "required": false, - "type": "map" + "name": "name", + "required": true, + "type": "string" }, { "description": "the URL of the storage pool", @@ -98930,20 +101045,6 @@ "required": true, "type": "string" }, - { - "description": "bytes CloudStack can provision from this storage pool", - "length": 255, - "name": "capacitybytes", - "required": false, - "type": "long" - }, - { - "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": "the cluster ID for the storage pool", "length": 255, @@ -98953,80 +101054,81 @@ "type": "uuid" }, { - "description": "the scope of the storage: cluster or zone", + "description": "the details for the storage pool", "length": 255, - "name": "scope", + "name": "details", "required": false, - "type": "string" + "type": "map" + }, + { + "description": "bytes CloudStack can provision from this storage pool", + "length": 255, + "name": "capacitybytes", + "required": false, + "type": "long" } ], "related": "cancelStorageMaintenance,findStoragePoolsForMigration,enableStorageMaintenance", "response": [ { - "description": "the ID of the cluster for the storage pool", - "name": "clusterid", + "description": "the tags for the storage pool", + "name": "tags", "type": "string" }, - {}, - { - "description": "the state of the storage pool", - "name": "state", - "type": "storagepoolstatus" - }, { - "description": "the IP address of the storage pool", - "name": "ipaddress", - "type": "string" + "description": "the host's currently used disk size", + "name": "disksizeused", + "type": "long" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "IOPS CloudStack can provision from this storage pool", + "name": "capacityiops", + "type": "long" }, + {}, { - "description": "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 scope of the storage pool", - "name": "scope", + "description": "the hypervisor type of the storage pool", + "name": "hypervisor", "type": "string" }, { - "description": "the Pod ID of the storage pool", - "name": "podid", + "description": "the Zone ID of the storage pool", + "name": "zoneid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the Zone name of the storage pool", + "name": "zonename", + "type": "string" }, { - "description": "the total disk size of the storage pool", - "name": "disksizetotal", - "type": "long" + "description": "the ID of the storage pool", + "name": "id", + "type": "string" }, - {}, { "description": "the name of the cluster for the storage pool", "name": "clustername", "type": "string" }, - { - "description": "the storage pool capabilities", - "name": "storagecapabilities", - "type": "map" - }, { "description": "the host's currently allocated disk size", "name": "disksizeallocated", "type": "long" }, { - "description": "the storage pool type", - "name": "type", + "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" }, { @@ -99035,40 +101137,51 @@ "type": "long" }, { - "description": "the ID of the storage pool", - "name": "id", + "description": "the storage pool type", + "name": "type", "type": "string" }, { - "description": "the Zone name of the storage pool", - "name": "zonename", + "description": "the ID of the cluster for the storage pool", + "name": "clusterid", "type": "string" }, { - "description": "the tags for the storage pool", - "name": "tags", + "description": "the storage pool path", + "name": "path", "type": "string" }, + { + "description": "the state of the storage pool", + "name": "state", + "type": "storagepoolstatus" + }, { "description": "the Pod name of the storage pool", "name": "podname", "type": "string" }, { - "description": "the Zone ID of the storage pool", - "name": "zoneid", + "description": "the overprovisionfactor for the storage pool", + "name": "overprovisionfactor", "type": "string" }, { - "description": "the name of the storage pool", - "name": "name", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, + {}, { - "description": "the storage pool path", - "name": "path", + "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": "Storage provider for this pool", "name": "provider", @@ -99079,30 +101192,25 @@ "name": "created", "type": "date" }, - { - "description": "the overprovisionfactor for the storage pool", - "name": "overprovisionfactor", - "type": "string" - }, { "description": "true if this pool is suitable to migrate a volume, false otherwise", "name": "suitableformigration", "type": "boolean" }, { - "description": "the host's currently used disk size", - "name": "disksizeused", - "type": "long" + "description": "the name of the storage pool", + "name": "name", + "type": "string" }, { - "description": "IOPS CloudStack can provision from this storage pool", - "name": "capacityiops", - "type": "long" + "description": "the scope of the storage pool", + "name": "scope", + "type": "string" }, { - "description": "the hypervisor type of the storage pool", - "name": "hypervisor", - "type": "string" + "description": "the storage pool capabilities", + "name": "storagecapabilities", + "type": "map" } ] }, @@ -99118,13 +101226,6 @@ "required": false, "type": "integer" }, - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - }, { "description": "", "length": 255, @@ -99139,33 +101240,40 @@ "related": "createVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", "required": true, "type": "uuid" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" } ], "related": "cancelStorageMaintenance,enableStorageMaintenance", "response": [ { - "description": "the state of the storage pool", - "name": "state", - "type": "storagepoolstatus" + "description": "the Zone name of the storage pool", + "name": "zonename", + "type": "string" }, { - "description": "Storage provider for this pool", - "name": "provider", - "type": "string" + "description": "the total disk size of the storage pool", + "name": "disksizetotal", + "type": "long" }, { - "description": "the Pod ID of the storage pool", - "name": "podid", + "description": "the name of the cluster for the storage pool", + "name": "clustername", "type": "string" }, { - "description": "the overprovisionfactor for the storage pool", - "name": "overprovisionfactor", + "description": "the storage pool type", + "name": "type", "type": "string" }, { - "description": "the Zone name of the storage pool", - "name": "zonename", + "description": "the storage pool path", + "name": "path", "type": "string" }, { @@ -99174,39 +101282,40 @@ "type": "string" }, { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", - "type": "long" + "description": "the Pod ID of the storage pool", + "name": "podid", + "type": "string" }, { - "description": "the storage pool path", - "name": "path", - "type": "string" + "description": "the state of the storage pool", + "name": "state", + "type": "storagepoolstatus" }, { - "description": "total min IOPS currently in use by volumes", - "name": "allocatediops", + "description": "the host's currently used disk size", + "name": "disksizeused", "type": "long" }, { - "description": "the total disk size of the storage pool", - "name": "disksizetotal", - "type": "long" + "description": "the storage pool capabilities", + "name": "storagecapabilities", + "type": "map" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Storage provider for this pool", + "name": "provider", "type": "string" }, { - "description": "the ID of the cluster for the storage pool", - "name": "clusterid", - "type": "string" + "description": "the date and time the storage pool was created", + "name": "created", + "type": "date" }, + {}, { - "description": "the Pod name of the storage pool", - "name": "podname", - "type": "string" + "description": "the host's currently allocated disk size", + "name": "disksizeallocated", + "type": "long" }, { "description": "the current status of the latest async job acting on this object", @@ -99214,50 +101323,44 @@ "type": "integer" }, { - "description": "true if this pool is suitable to migrate a volume, false otherwise", - "name": "suitableformigration", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, + {}, { - "description": "the ID of the storage pool", - "name": "id", + "description": "the name of the storage pool", + "name": "name", "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 hypervisor type of the storage pool", - "name": "hypervisor", + "description": "the ID of the cluster for the storage pool", + "name": "clusterid", "type": "string" }, { - "description": "the name of the storage pool", - "name": "name", + "description": "the IP address of the storage pool", + "name": "ipaddress", "type": "string" }, { - "description": "the host's currently used disk size", - "name": "disksizeused", - "type": "long" - }, - {}, - { - "description": "the date and time the storage pool was created", - "name": "created", - "type": "date" + "description": "the ID of the storage pool", + "name": "id", + "type": "string" }, - {}, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the tags for the storage pool", - "name": "tags", + "description": "the overprovisionfactor for the storage pool", + "name": "overprovisionfactor", "type": "string" }, { @@ -99266,9 +101369,9 @@ "type": "string" }, { - "description": "the storage pool capabilities", - "name": "storagecapabilities", - "type": "map" + "description": "the hypervisor type of the storage pool", + "name": "hypervisor", + "type": "string" }, { "description": "IOPS CloudStack can provision from this storage pool", @@ -99276,14 +101379,19 @@ "type": "long" }, { - "description": "the IP address of the storage pool", - "name": "ipaddress", + "description": "the Pod name of the storage pool", + "name": "podname", "type": "string" }, { - "description": "the storage pool type", - "name": "type", + "description": "the tags for the storage pool", + "name": "tags", "type": "string" + }, + { + "description": "true if this pool is suitable to migrate a volume, false otherwise", + "name": "suitableformigration", + "type": "boolean" } ] }, @@ -99293,19 +101401,19 @@ "name": "addOpenDaylightController", "params": [ { - "description": "the Physical Network ID", + "description": "Credential to access the OpenDaylight API", "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork", + "name": "password", "required": true, - "type": "uuid" + "type": "string" }, { - "description": "Credential to access the OpenDaylight API", + "description": "the Physical Network ID", "length": 255, - "name": "password", + "name": "physicalnetworkid", + "related": "createPhysicalNetwork", "required": true, - "type": "string" + "type": "uuid" }, { "description": "Username to access the OpenDaylight API", @@ -99325,23 +101433,23 @@ "related": "", "response": [ { - "description": "the physical network to which this controller belongs to", - "name": "physicalnetworkid", + "description": "device id of the controller", + "name": "id", "type": "string" }, { - "description": "the name assigned to the controller", - "name": "name", + "description": "the UUID of the latest async job acting on 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 assigned to the controller", + "name": "name", + "type": "string" }, { - "description": "device id of the controller", - "name": "id", + "description": "the physical network to which this controller belongs to", + "name": "physicalnetworkid", "type": "string" }, { @@ -99349,18 +101457,18 @@ "name": "username", "type": "string" }, + {}, { - "description": "the url of the controller api", - "name": "url", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the url of the controller api", + "name": "url", "type": "string" - }, - {} + } ] }, { @@ -99369,9 +101477,16 @@ "name": "createZone", "params": [ { - "description": "network type of the zone, can be Basic or Advanced", + "description": "Network domain name for the networks in the zone", "length": 255, - "name": "networktype", + "name": "domain", + "required": false, + "type": "string" + }, + { + "description": "the first DNS for the Zone", + "length": 255, + "name": "dns1", "required": true, "type": "string" }, @@ -99384,45 +101499,38 @@ "type": "uuid" }, { - "description": "true if network is security group enabled, false otherwise", - "length": 255, - "name": "securitygroupenabled", - "required": false, - "type": "boolean" - }, - { - "description": "the guest CIDR address for the Zone", + "description": "the first internal DNS for the Zone", "length": 255, - "name": "guestcidraddress", - "required": false, + "name": "internaldns1", + "required": true, "type": "string" }, { - "description": "true if local storage offering enabled, false otherwise", + "description": "Allocation state of this Zone for allocation of new resources", "length": 255, - "name": "localstorageenabled", + "name": "allocationstate", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "the second DNS for IPv6 network in the Zone", + "description": "network type of the zone, can be Basic or Advanced", "length": 255, - "name": "ip6dns2", - "required": false, + "name": "networktype", + "required": true, "type": "string" }, { - "description": "the first DNS for IPv6 network in the Zone", + "description": "the guest CIDR address for the Zone", "length": 255, - "name": "ip6dns1", + "name": "guestcidraddress", "required": false, "type": "string" }, { - "description": "the first internal DNS for the Zone", + "description": "the second DNS for IPv6 network in the Zone", "length": 255, - "name": "internaldns1", - "required": true, + "name": "ip6dns2", + "required": false, "type": "string" }, { @@ -99433,66 +101541,87 @@ "type": "string" }, { - "description": "the second internal DNS for the Zone", + "description": "the name of the Zone", "length": 255, - "name": "internaldns2", - "required": false, + "name": "name", + "required": true, "type": "string" }, { - "description": "the first DNS for the Zone", + "description": "true if local storage offering enabled, false otherwise", "length": 255, - "name": "dns1", - "required": true, - "type": "string" + "name": "localstorageenabled", + "required": false, + "type": "boolean" }, { - "description": "Allocation state of this Zone for allocation of new resources", + "description": "true if network is security group enabled, false otherwise", "length": 255, - "name": "allocationstate", + "name": "securitygroupenabled", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "Network domain name for the networks in the zone", + "description": "the second internal DNS for the Zone", "length": 255, - "name": "domain", + "name": "internaldns2", "required": false, "type": "string" }, { - "description": "the name of the Zone", + "description": "the first DNS for IPv6 network in the Zone", "length": 255, - "name": "name", - "required": true, + "name": "ip6dns1", + "required": false, "type": "string" } ], "related": "listZones", "response": [ + { + "description": "the first internal DNS for the Zone", + "name": "internaldns1", + "type": "string" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + {}, + { + "description": "the display text of the zone", + "name": "displaytext", + "type": "string" + }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, { "description": "the capacity of the Zone", "name": "capacity", "response": [ { - "description": "the capacity currently in use", - "name": "capacityused", - "type": "long" - }, - { - "description": "the Pod ID", - "name": "podid", + "description": "the Cluster ID", + "name": "clusterid", "type": "string" }, { - "description": "the total capacity available", - "name": "capacitytotal", - "type": "long" + "description": "the Cluster name", + "name": "clustername", + "type": "string" }, { "description": "the capacity name", @@ -99500,24 +101629,24 @@ "type": "string" }, { - "description": "the Pod name", - "name": "podname", + "description": "the percentage of capacity currently in use", + "name": "percentused", "type": "string" }, { - "description": "the Cluster ID", - "name": "clusterid", - "type": "string" + "description": "the total capacity available", + "name": "capacitytotal", + "type": "long" }, { - "description": "the Zone ID", - "name": "zoneid", + "description": "the Pod name", + "name": "podname", "type": "string" }, { - "description": "the Zone name", - "name": "zonename", - "type": "string" + "description": "the capacity currently in use", + "name": "capacityused", + "type": "long" }, { "description": "the capacity type", @@ -99525,62 +101654,81 @@ "type": "short" }, { - "description": "the capacity currently in allocated", - "name": "capacityallocated", - "type": "long" + "description": "the Zone name", + "name": "zonename", + "type": "string" }, { - "description": "the percentage of capacity currently in use", - "name": "percentused", + "description": "the Zone ID", + "name": "zoneid", "type": "string" }, { - "description": "the Cluster name", - "name": "clustername", + "description": "the Pod ID", + "name": "podid", "type": "string" + }, + { + "description": "the capacity currently in allocated", + "name": "capacityallocated", + "type": "long" } ], "type": "list" }, + { + "description": "the network type of the zone; can be Basic or Advanced", + "name": "networktype", + "type": "string" + }, + { + "description": "the allocation state of the cluster", + "name": "allocationstate", + "type": "string" + }, { "description": "Meta data associated with the zone (key/value pairs)", "name": "resourcedetails", "type": "map" }, { - "description": "the UUID of the containing domain, null for public zones", - "name": "domainid", + "description": "Zone name", + "name": "name", "type": "string" }, { - "description": "the network type of the zone; can be Basic or Advanced", - "name": "networktype", + "description": "Zone Token", + "name": "zonetoken", "type": "string" }, { - "description": "the allocation state of the cluster", - "name": "allocationstate", + "description": "the guest CIDR address for the Zone", + "name": "guestcidraddress", "type": "string" }, { - "description": "Zone name", - "name": "name", + "description": "the name of the containing domain, null for public zones", + "name": "domainname", "type": "string" }, { - "description": "Network domain name for the networks in the zone", - "name": "domain", + "description": "the second DNS for the Zone", + "name": "dns2", "type": "string" }, - {}, { - "description": "true if local storage offering enabled, false otherwise", - "name": "localstorageenabled", - "type": "boolean" + "description": "Zone description", + "name": "description", + "type": "string" }, { - "description": "the dhcp Provider for the Zone", - "name": "dhcpprovider", + "description": "the second internal DNS for the Zone", + "name": "internaldns2", + "type": "string" + }, + { + "description": "the first IPv6 DNS for the Zone", + "name": "ip6dns1", "type": "string" }, { @@ -99588,8 +101736,13 @@ "name": "tags", "response": [ { - "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" }, { @@ -99602,11 +101755,6 @@ "name": "resourcetype", "type": "string" }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, { "description": "the ID of the domain associated with the tag", "name": "domainid", @@ -99617,6 +101765,11 @@ "name": "domain", "type": "string" }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, { "description": "the project id the tag belongs to", "name": "projectid", @@ -99631,94 +101784,49 @@ "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": "Zone description", - "name": "description", - "type": "string" - }, - { - "description": "Zone Token", - "name": "zonetoken", - "type": "string" - }, - { - "description": "the first DNS for the Zone", - "name": "dns1", - "type": "string" - }, - { - "description": "the display text of the zone", - "name": "displaytext", + "description": "the dhcp Provider for the Zone", + "name": "dhcpprovider", "type": "string" }, { - "description": "the second internal DNS for the Zone", - "name": "internaldns2", + "description": "Network domain name for the networks in the zone", + "name": "domain", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "true if security groups support is enabled, false otherwise", - "name": "securitygroupsenabled", + "description": "true if local storage offering enabled, false otherwise", + "name": "localstorageenabled", "type": "boolean" }, { - "description": "the second IPv6 DNS for the Zone", - "name": "ip6dns2", + "description": "the UUID of the containing domain, null for public zones", + "name": "domainid", "type": "string" }, - { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, { "description": "Zone id", "name": "id", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the name of the containing domain, null for public zones", - "name": "domainname", - "type": "string" - }, - { - "description": "the first internal DNS for the Zone", - "name": "internaldns1", - "type": "string" - }, - { - "description": "the guest CIDR address for the Zone", - "name": "guestcidraddress", + "description": "the first DNS for the Zone", + "name": "dns1", "type": "string" }, {}, { - "description": "the second DNS for the Zone", - "name": "dns2", - "type": "string" + "description": "true if security groups support is enabled, false otherwise", + "name": "securitygroupsenabled", + "type": "boolean" }, { - "description": "the first IPv6 DNS for the Zone", - "name": "ip6dns1", + "description": "the second IPv6 DNS for the Zone", + "name": "ip6dns2", "type": "string" } ] @@ -99740,44 +101848,39 @@ "related": "listCiscoNexusVSMs", "response": [ { - "description": "The mode of the VSM (standalone/HA)", - "name": "vsmconfigmode", + "description": "device name", + "name": "vsmdevicename", "type": "string" }, + {}, { - "description": "management vlan id of the VSM", - "name": "vsmmgmtvlanid", + "description": "The Device State (Enabled/Disabled) of the VSM", + "name": "vsmdevicestate", "type": "string" }, { - "description": "storage vlan id of the VSM", - "name": "vsmstoragevlanid", + "description": "control vlan id of the VSM", + "name": "vsmctrlvlanid", "type": "int" }, { - "description": "The Device State (Enabled/Disabled) of the VSM", - "name": "vsmdevicestate", + "description": "the management IP address of the external Cisco Nexus 1000v Virtual Supervisor Module", + "name": "ipaddress", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "The VSM is a switch supervisor. This is the VSM's switch domain id", - "name": "vsmdomainid", - "type": "string" + "description": "storage vlan id of the VSM", + "name": "vsmstoragevlanid", + "type": "int" }, - {}, { - "description": "device name", - "name": "vsmdevicename", + "description": "device state", + "name": "vsmdevicestate", "type": "string" }, { - "description": "The Config State (Primary/Standby) of the VSM", - "name": "vsmconfigstate", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -99785,30 +101888,35 @@ "name": "vsmpktvlanid", "type": "int" }, - {}, { - "description": "device state", - "name": "vsmdevicestate", + "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", + "description": "The mode of the VSM (standalone/HA)", + "name": "vsmconfigmode", "type": "string" }, { - "description": "control vlan id of the VSM", - "name": "vsmctrlvlanid", - "type": "int" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the management IP address of the external Cisco Nexus 1000v Virtual Supervisor Module", - "name": "ipaddress", + "description": "management vlan id of the VSM", + "name": "vsmmgmtvlanid", "type": "string" }, { - "description": "device id of the Cisco N1KV VSM device", - "name": "vsmdeviceid", + "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" } ] @@ -99818,13 +101926,6 @@ "isasync": true, "name": "createStorageNetworkIpRange", "params": [ - { - "description": "the ending IP address", - "length": 255, - "name": "endip", - "required": false, - "type": "string" - }, { "description": "the netmask for storage network", "length": 255, @@ -99833,50 +101934,74 @@ "type": "string" }, { - "description": "the beginning IP address", + "description": "UUID of pod where the ip range belongs to", "length": 255, - "name": "startip", + "name": "podid", + "related": "updatePod,createManagementNetworkIpRange", "required": true, - "type": "string" + "type": "uuid" }, { - "description": "the gateway for storage network", + "description": "Optional. The vlan the ip range sits on, default to Null when it is not specified which means you network is not on any Vlan. This is mainly for Vmware as other hypervisors can directly reterive bridge from pyhsical network traffic type table", "length": 255, - "name": "gateway", + "name": "vlan", + "required": false, + "type": "integer" + }, + { + "description": "the beginning IP address", + "length": 255, + "name": "startip", "required": true, "type": "string" }, { - "description": "Optional. The vlan the ip range sits on, default to Null when it is not specificed which means you network is not on any Vlan. This is mainly for Vmware as other hypervisors can directly reterive bridge from pyhsical network traffic type table", + "description": "the ending IP address", "length": 255, - "name": "vlan", + "name": "endip", "required": false, - "type": "integer" + "type": "string" }, { - "description": "UUID of pod where the ip range belongs to", + "description": "the gateway for storage network", "length": 255, - "name": "podid", - "related": "updatePod,createManagementNetworkIpRange", + "name": "gateway", "required": true, - "type": "uuid" + "type": "string" } ], "related": "", "response": [ + { + "description": "the gateway of the storage network IP range", + "name": "gateway", + "type": "string" + }, + {}, + { + "description": "the network uuid of storage network IP range", + "name": "networkid", + "type": "string" + }, + { + "description": "the Zone uuid of the storage network IP range", + "name": "zoneid", + "type": "string" + }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "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 gateway of the storage network IP range", - "name": "gateway", + "description": "the Pod uuid for the storage network IP range", + "name": "podid", "type": "string" }, { @@ -99884,12 +102009,6 @@ "name": "endip", "type": "string" }, - {}, - { - "description": "the start ip of the storage network IP range", - "name": "startip", - "type": "string" - }, { "description": "the uuid of storage network IP range.", "name": "id", @@ -99901,24 +102020,13 @@ "type": "integer" }, { - "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 network uuid of storage network IP range", - "name": "networkid", + "description": "the start ip of the storage network IP range", + "name": "startip", "type": "string" }, - {}, { - "description": "the Zone uuid of the storage network IP range", - "name": "zoneid", + "description": "the netmask of the storage network IP range", + "name": "netmask", "type": "string" } ], @@ -99930,11 +102038,11 @@ "name": "listDomainChildren", "params": [ { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { "description": "list children domain by parent domain ID.", @@ -99944,13 +102052,6 @@ "required": false, "type": "uuid" }, - { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false", - "length": 255, - "name": "listall", - "required": false, - "type": "boolean" - }, { "description": "list children domains by name", "length": 255, @@ -99959,16 +102060,16 @@ "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", "length": 255, - "name": "page", + "name": "listall", "required": false, - "type": "integer" + "type": "boolean" }, { - "description": "flag to display the resource icon for domains", + "description": "to return the entire tree, use the value \"true\". To return the first level children, use the value \"false\".", "length": 255, - "name": "showicon", + "name": "isrecursive", "required": false, "type": "boolean" }, @@ -99980,9 +102081,16 @@ "type": "integer" }, { - "description": "to return the entire tree, use the value \"true\". To return the first level children, use the value \"false\".", + "description": "List by keyword", "length": 255, - "name": "isrecursive", + "name": "keyword", + "required": false, + "type": "string" + }, + { + "description": "flag to display the resource icon for domains", + "length": 255, + "name": "showicon", "required": false, "type": "boolean" } @@ -99990,43 +102098,33 @@ "related": "listDomains", "response": [ { - "description": "the total number of snapshots available for this domain", - "name": "snapshotavailable", - "type": "string" - }, - { - "description": "the total number of virtual machines available for this domain to acquire", - "name": "vmavailable", - "type": "string" - }, - { - "description": "the total number of templates available to be created by this domain", - "name": "templateavailable", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the total number of public ip addresses this domain can acquire", - "name": "iplimit", - "type": "string" + "description": "the date when this domain was created", + "name": "created", + "type": "date" }, { - "description": "the path of the domain", - "name": "path", - "type": "string" + "description": "the level of the domain", + "name": "level", + "type": "integer" }, { - "description": "the total number of vpcs available to be created for this domain", - "name": "vpcavailable", + "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 available to be created for this domain", - "name": "networkavailable", + "description": "the total number of cpu cores the domain can own", + "name": "cpulimit", "type": "string" }, { - "description": "the total number of snapshots which can be stored by this domain", - "name": "snapshotlimit", + "description": "the total secondary storage space (in GiB) available to be used for this domain", + "name": "secondarystorageavailable", "type": "string" }, { @@ -100034,139 +102132,151 @@ "name": "vpctotal", "type": "long" }, + { + "description": "the total secondary storage space (in GiB) owned by domain", + "name": "secondarystoragetotal", + "type": "float" + }, { "description": "the total number of public ip addresses allocated for this domain", "name": "iptotal", "type": "long" }, { - "description": "the total number of cpu cores owned by domain", - "name": "cputotal", - "type": "long" + "description": "the total volume which can be used by this domain", + "name": "volumelimit", + "type": "string" }, + {}, { - "description": "the total secondary storage space (in GiB) the domain can own", - "name": "secondarystoragelimit", - "type": "string" + "description": "the total number of templates which have been created by this domain", + "name": "templatetotal", + "type": "long" }, { - "description": "the domain ID of the parent domain", - "name": "parentdomainid", + "description": "the total primary storage space (in GiB) the domain can own", + "name": "primarystoragelimit", "type": "string" }, { - "description": "the ID of the domain", - "name": "id", - "type": "string" + "description": "the total number of networks owned by domain", + "name": "networktotal", + "type": "long" }, { - "description": "the total volume which can be used by this domain", - "name": "volumelimit", + "description": "the total number of networks available to be created for this domain", + "name": "networkavailable", "type": "string" }, { - "description": "whether the domain has one or more sub-domains", - "name": "haschild", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the total number of public ip addresses this domain can acquire", + "name": "iplimit", "type": "string" }, + { + "description": "the total primary storage space (in GiB) owned by domain", + "name": "primarystoragetotal", + "type": "long" + }, { "description": "the total volume being used by this domain", "name": "volumetotal", "type": "long" }, { - "description": "the total number of snapshots stored by this domain", - "name": "snapshottotal", - "type": "long" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the total number of networks owned by domain", - "name": "networktotal", + "description": "the total number of cpu cores owned by domain", + "name": "cputotal", "type": "long" }, { - "description": "the total secondary storage space (in GiB) available to be used for this domain", - "name": "secondarystorageavailable", + "description": "the total number of public ip addresses available for this domain to acquire", + "name": "ipavailable", "type": "string" }, { - "description": "the total number of virtual machines deployed by this domain", - "name": "vmtotal", - "type": "long" + "description": "the total number of virtual machines that can be deployed by this domain", + "name": "vmlimit", + "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the total number of projects the domain can own", + "name": "projectlimit", + "type": "string" }, { - "description": "the total primary storage space (in GiB) the domain can own", - "name": "primarystoragelimit", + "description": "the total number of vpcs available to be created for this domain", + "name": "vpcavailable", "type": "string" }, { - "description": "the total primary storage space (in GiB) available to be used for this domain", - "name": "primarystorageavailable", + "description": "the total number of networks the domain can own", + "name": "networklimit", "type": "string" }, { - "description": "details for the domain", - "name": "domaindetails", - "type": "map" + "description": "the domain name of the parent domain", + "name": "parentdomainname", + "type": "string" }, { - "description": "the network domain", - "name": "networkdomain", + "description": "the domain ID of the parent domain", + "name": "parentdomainid", "type": "string" }, + {}, { - "description": "the level of the domain", - "name": "level", - "type": "integer" + "description": "whether the domain has one or more sub-domains", + "name": "haschild", + "type": "boolean" }, { - "description": "the total volume available for this domain", - "name": "volumeavailable", + "description": "the ID of the domain", + "name": "id", "type": "string" }, { - "description": "the domain name of the parent domain", - "name": "parentdomainname", + "description": "the state of the domain", + "name": "state", "type": "string" }, { - "description": "the total number of templates which have been created by this domain", - "name": "templatetotal", - "type": "long" + "description": "the network domain", + "name": "networkdomain", + "type": "string" }, { - "description": "the total memory (in MB) owned by domain", - "name": "memorytotal", + "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", + "description": "the total secondary storage space (in GiB) the domain can own", + "name": "secondarystoragelimit", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the total memory (in MB) owned by domain", + "name": "memorytotal", + "type": "long" }, { - "description": "the total number of networks the domain can own", - "name": "networklimit", - "type": "string" + "description": "the total number of virtual machines deployed by this domain", + "name": "vmtotal", + "type": "long" }, { - "description": "the total number of public ip addresses available for this domain to acquire", - "name": "ipavailable", + "description": "the total number of vpcs the domain can own", + "name": "vpclimit", "type": "string" }, { @@ -100174,57 +102284,60 @@ "name": "cpuavailable", "type": "string" }, + { + "description": "the total volume available for this domain", + "name": "volumeavailable", + "type": "string" + }, { "description": "the total memory (in MB) available to be created for this domain", "name": "memoryavailable", "type": "string" }, - {}, { - "description": "the total number of projects available for administration by this domain", - "name": "projectavailable", + "description": "the total number of virtual machines available for this domain to acquire", + "name": "vmavailable", "type": "string" }, { - "description": "the name of the domain", - "name": "name", + "description": "the total number of snapshots available for this domain", + "name": "snapshotavailable", "type": "string" }, { - "description": "the total number of projects the domain can own", - "name": "projectlimit", - "type": "string" + "description": "the total number of snapshots stored by this domain", + "name": "snapshottotal", + "type": "long" }, { "description": "the total memory (in MB) the domain can own", "name": "memorylimit", "type": "string" }, - {}, { - "description": "the total primary storage space (in GiB) owned by domain", - "name": "primarystoragetotal", - "type": "long" + "description": "the name of the domain", + "name": "name", + "type": "string" }, { - "description": "the state of the domain", - "name": "state", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the total number of projects being administrated by this domain", - "name": "projecttotal", - "type": "long" + "description": "the path of the domain", + "name": "path", + "type": "string" }, { - "description": "the date when this domain was created", - "name": "created", - "type": "date" + "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 snapshots which can be stored by this domain", + "name": "snapshotlimit", + "type": "string" }, { "description": "the total number of templates which can be created by this domain", @@ -100232,18 +102345,13 @@ "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 total number of templates available to be created by this domain", + "name": "templateavailable", "type": "string" }, { - "description": "the total number of vpcs the domain can own", - "name": "vpclimit", + "description": "the total number of projects available for administration by this domain", + "name": "projectavailable", "type": "string" } ] @@ -100264,12 +102372,6 @@ ], "related": "", "response": [ - {}, - { - "description": "The base64 encoded encrypted password of the VM", - "name": "encryptedpassword", - "type": "string" - }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", @@ -100280,6 +102382,12 @@ "name": "jobstatus", "type": "integer" }, + { + "description": "The base64 encoded encrypted password of the VM", + "name": "encryptedpassword", + "type": "string" + }, + {}, {} ] }, @@ -100296,13 +102404,6 @@ "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, @@ -100310,9 +102411,26 @@ "related": "", "required": true, "type": "uuid" + }, + { + "description": "Map of LB rule id's and corresponding weights (between 1-100) in the GSLB rule, if not specified weight of a LB rule is defaulted to 1. Specified as 'gslblbruleweightsmap[0].loadbalancerid=UUID&gslblbruleweightsmap[0].weight=10'", + "length": 255, + "name": "gslblbruleweightsmap", + "required": false, + "type": "map" } ], "response": [ + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + }, { "description": "true if operation is executed successfully", "name": "success", @@ -100324,17 +102442,7 @@ "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" - } + {} ] }, { @@ -100360,31 +102468,31 @@ ], "related": "", "response": [ - {}, {}, { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "the domain ID associated with the provider", + "name": "domainid", "type": "string" }, { - "description": "the account associated with the provider", - "name": "account", + "description": "the project id of the ipaddress", + "name": "projectid", "type": "string" }, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "the domain associated with the provider", - "name": "domain", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the domain ID associated with the provider", - "name": "domainid", + "description": "the account associated with the provider", + "name": "account", "type": "string" }, { @@ -100392,25 +102500,25 @@ "name": "nspid", "type": "string" }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "Enabled/Disabled the service provider", - "name": "enabled", - "type": "boolean" - }, { "description": "the project name of the address", "name": "project", "type": "string" }, + { + "description": "the domain associated with the provider", + "name": "domain", + "type": "string" + }, { "description": "the id of the ovs", "name": "id", "type": "string" + }, + { + "description": "Enabled/Disabled the service provider", + "name": "enabled", + "type": "boolean" } ] }, @@ -100420,30 +102528,37 @@ "name": "addImageStoreS3", "params": [ { - "description": "Name of the storage bucket", + "description": "Socket timeout (milliseconds)", "length": 255, - "name": "bucket", - "required": true, - "type": "string" + "name": "sockettimeout", + "required": false, + "type": "integer" }, { - "description": "S3 endpoint", + "description": "Connection TTL (milliseconds)", "length": 255, - "name": "endpoint", - "required": true, - "type": "string" + "name": "connectionttl", + "required": false, + "type": "integer" }, { - "description": "Whether TCP keep-alive is used", + "description": "Connection timeout (milliseconds)", "length": 255, - "name": "usetcpkeepalive", + "name": "connectiontimeout", "required": false, - "type": "boolean" + "type": "integer" }, { - "description": "S3 access key", + "description": "S3 secret key", "length": 255, - "name": "accesskey", + "name": "secretkey", + "required": true, + "type": "string" + }, + { + "description": "S3 endpoint", + "length": 255, + "name": "endpoint", "required": true, "type": "string" }, @@ -100455,44 +102570,37 @@ "type": "boolean" }, { - "description": "Signer Algorithm to use, either S3SignerType or AWSS3V4SignerType", + "description": "Name of the storage bucket", "length": 255, - "name": "s3signer", - "required": false, + "name": "bucket", + "required": true, "type": "string" }, { - "description": "Maximum number of times to retry on error", + "description": "Signer Algorithm to use, either S3SignerType or AWSS3V4SignerType", "length": 255, - "name": "maxerrorretry", + "name": "s3signer", "required": false, - "type": "integer" + "type": "string" }, { - "description": "S3 secret key", + "description": "S3 access key", "length": 255, - "name": "secretkey", + "name": "accesskey", "required": true, "type": "string" }, { - "description": "Connection TTL (milliseconds)", - "length": 255, - "name": "connectionttl", - "required": false, - "type": "integer" - }, - { - "description": "Socket timeout (milliseconds)", + "description": "Whether TCP keep-alive is used", "length": 255, - "name": "sockettimeout", + "name": "usetcpkeepalive", "required": false, - "type": "integer" + "type": "boolean" }, { - "description": "Connection timeout (milliseconds)", + "description": "Maximum number of times to retry on error", "length": 255, - "name": "connectiontimeout", + "name": "maxerrorretry", "required": false, "type": "integer" } @@ -100505,71 +102613,71 @@ "type": "string" }, { - "description": "the ID of the image store", - "name": "id", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the provider name of the image store", + "name": "providername", "type": "string" }, { - "description": "the scope of the image store", - "name": "scope", - "type": "scopetype" + "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 ID of the image store", + "name": "id", + "type": "string" }, { "description": "the protocol of the image store", "name": "protocol", "type": "string" }, - {}, { - "description": "the host's currently used disk size", - "name": "disksizeused", + "description": "the total disk size of the host", + "name": "disksizetotal", "type": "long" }, { - "description": "the Zone ID of the image store", - "name": "zoneid", - "type": "string" + "description": "defines if store is read-only", + "name": "readonly", + "type": "boolean" }, { - "description": "the name of the image store", - "name": "name", - "type": "string" + "description": "the host's currently used disk size", + "name": "disksizeused", + "type": "long" }, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "defines if store is read-only", - "name": "readonly", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "the total disk size of the host", - "name": "disksizetotal", - "type": "long" + "description": "the scope of the image store", + "name": "scope", + "type": "scopetype" }, { - "description": "the provider name of the image store", - "name": "providername", + "description": "the name of the image store", + "name": "name", "type": "string" }, { "description": "the url of the image store", "name": "url", "type": "string" - }, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" } ], "since": "4.7.0" @@ -100580,34 +102688,34 @@ "name": "uploadTemplateDirectDownloadCertificate", "params": [ { - "description": "Name for the uploaded certificate", + "description": "Hypervisor type", "length": 255, - "name": "name", + "name": "hypervisor", "required": true, "type": "string" }, { - "description": "Hypervisor type", + "description": "Zone to upload certificate", "length": 255, - "name": "hypervisor", + "name": "zoneid", + "related": "listZones", "required": true, - "type": "string" + "type": "uuid" }, { - "description": "(optional) the host ID to revoke certificate", + "description": "(optional) the host ID to upload certificate", "length": 255, "name": "hostid", - "related": "reconnectHost,addBaremetalHost", + "related": "addBaremetalHost,reconnectHost", "required": false, "type": "uuid" }, { - "description": "Zone to upload certificate", + "description": "Name for the uploaded certificate", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "name", "required": true, - "type": "uuid" + "type": "string" }, { "description": "SSL certificate", @@ -100617,28 +102725,74 @@ "type": "string" } ], + "related": "", "response": [ + { + "description": "the direct download certificate id", + "name": "id", + "type": "string" + }, + { + "description": "the hypervisor of the hosts where the certificate is uploaded", + "name": "hypervisor", + "type": "string" + }, + { + "description": "the direct download certificate issuer", + "name": "issuer", + "type": "string" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + {}, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "the zone id where the certificate is uploaded", + "name": "zoneid", + "type": "string" }, - {}, - {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the direct download certificate subject", + "name": "subject", + "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 issuer", + "name": "validity", + "type": "string" + }, + { + "description": "the hosts where the certificate is uploaded to", + "name": "hostsmap", + "type": "list" + }, + { + "description": "the direct download certificate serial num", + "name": "serialnum", + "type": "string" + }, + { + "description": "the direct download certificate alias", + "name": "alias", + "type": "string" + }, + { + "description": "the zone name where the certificate is uploaded", + "name": "zonename", + "type": "string" } ], "since": "4.11.0" @@ -100649,26 +102803,18 @@ "name": "importUnmanagedInstance", "params": [ { - "description": "the hypervisor name of the instance", - "length": 255, - "name": "name", - "required": true, - "type": "string" - }, - { - "description": "VM nic to ip address mapping using keys nic, ip4Address", + "description": "datadisk template to disk-offering mapping using keys disk and diskOffering", "length": 255, - "name": "nicipaddresslist", + "name": "datadiskofferinglist", "required": false, "type": "map" }, { - "description": "the cluster ID", + "description": "the display name of the instance", "length": 255, - "name": "clusterid", - "related": "addCluster", - "required": true, - "type": "uuid" + "name": "displayname", + "required": false, + "type": "string" }, { "description": "the ID of the template for the virtual machine", @@ -100678,13 +102824,6 @@ "required": false, "type": "uuid" }, - { - "description": "used to specify the custom parameters.", - "length": 255, - "name": "details", - "required": false, - "type": "map" - }, { "description": "import instance to the domain specified", "length": 255, @@ -100694,46 +102833,47 @@ "type": "uuid" }, { - "description": "the display name of the instance", + "description": "VM is imported despite some of its NIC's MAC addresses are already present", "length": 255, - "name": "displayname", + "name": "forced", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "vm and its volumes are allowed to migrate to different host/pool when offerings passed are incompatible with current host/pool", + "description": "the hypervisor name of the instance", "length": 255, - "name": "migrateallowed", - "required": false, - "type": "boolean" + "name": "name", + "required": true, + "type": "string" }, { - "description": "datadisk template to disk-offering mapping using keys disk and diskOffering", + "description": "VM nic to network id mapping using keys nic and network", "length": 255, - "name": "datadiskofferinglist", + "name": "nicnetworklist", "required": false, "type": "map" }, { - "description": "VM is imported despite some of its NIC's MAC addresses are already present", + "description": "used to specify the custom parameters.", "length": 255, - "name": "forced", + "name": "details", "required": false, - "type": "boolean" + "type": "map" }, { - "description": "VM nic to network id mapping using keys nic and network", + "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": "nicnetworklist", + "name": "migrateallowed", "required": false, - "type": "map" + "type": "boolean" }, { - "description": "the host name of the instance", + "description": "import instance for the project", "length": 255, - "name": "hostname", + "name": "projectid", + "related": "activateProject", "required": false, - "type": "string" + "type": "uuid" }, { "description": "the ID of the service offering for the virtual machine", @@ -100743,6 +102883,14 @@ "required": true, "type": "uuid" }, + { + "description": "the cluster ID", + "length": 255, + "name": "clusterid", + "related": "addCluster", + "required": true, + "type": "uuid" + }, { "description": "an optional account for the virtual machine. Must be used with domainId.", "length": 255, @@ -100751,34 +102899,25 @@ "type": "string" }, { - "description": "import instance for the project", + "description": "the host name of the instance", "length": 255, - "name": "projectid", - "related": "activateProject", + "name": "hostname", "required": false, - "type": "uuid" + "type": "string" + }, + { + "description": "VM nic to ip address mapping using keys nic, ip4Address", + "length": 255, + "name": "nicipaddresslist", + "required": false, + "type": "map" } ], "related": "attachIso,destroyVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,startVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines", "response": [ { - "description": "the pool type of the virtual machine", - "name": "pooltype", - "type": "string" - }, - { - "description": "the ID of the disk offering of the virtual machine", - "name": "diskofferingid", - "type": "string" - }, - { - "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": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", "type": "string" }, { @@ -100787,133 +102926,139 @@ "type": "string" }, { - "description": "the outgoing network traffic on the host", - "name": "networkkbswrite", - "type": "long" - }, - { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", + "description": "the memory used by the VM in KiB", + "name": "memorykbs", "type": "long" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", - "type": "string" - }, - { - "description": "the ID of the host for the virtual machine", - "name": "hostid", + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", "type": "string" }, { - "description": "OS type id of the vm", - "name": "ostypeid", + "description": "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": "Guest vm Boot Type", + "name": "boottype", "type": "string" }, { - "description": "the list of resource tags associated", - "name": "tags", + "description": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", "response": [ { - "description": "the account associated with the tag", - "name": "account", + "description": "the name of the affinity group", + "name": "name", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the description of the affinity group", + "name": "description", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the domain ID of the affinity group", + "name": "domainid", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the account owning the affinity group", + "name": "account", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the type of the affinity group", + "name": "type", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the domain name of the affinity group", + "name": "domain", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the project name of the affinity group", + "name": "project", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the ID of the affinity group", + "name": "id", "type": "string" }, { - "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": "id of the resource", - "name": "resourceid", + "description": "the project ID of the affinity group", + "name": "projectid", "type": "string" } ], "type": "set" }, { - "description": "the read (bytes) of disk on the vm", - "name": "diskkbsread", - "type": "long" + "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", + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" + }, + { + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", "type": "string" }, - {}, { - "description": "the group name of the virtual machine", - "name": "group", + "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": "OS type id of the vm", + "name": "ostypeid", + "type": "string" }, + {}, { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" + "description": "the name of the virtual machine", + "name": "name", + "type": "string" }, { - "description": "the internal memory that's free in vm or zero if it can not be calculated", - "name": "memoryintfreekbs", - "type": "long" + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", + "type": "string" }, { - "description": "Guest vm Boot Type", - "name": "boottype", + "description": "the ID of the virtual machine", + "name": "id", "type": "string" }, { - "description": "device type of the root volume", - "name": "rootdevicetype", + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", + "type": "string" + }, + { + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" + }, + { + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, + {}, { "description": "list of security groups associated with the virtual machine", "name": "securitygroup", @@ -100923,9 +103068,9 @@ "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": "account owning the security group rule", @@ -100933,28 +103078,23 @@ "type": "string" }, { - "description": "the protocol of the security group rule", - "name": "protocol", + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", "type": "string" }, { - "description": "the ending IP of the security group rule ", - "name": "endport", + "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 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" }, { @@ -100962,6 +103102,11 @@ "name": "startport", "type": "integer" }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, { "description": "security group name", "name": "securitygroupname", @@ -100972,8 +103117,13 @@ "name": "tags", "response": [ { - "description": "customer associated with the tag", - "name": "customer", + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { @@ -100982,8 +103132,8 @@ "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { @@ -100992,33 +103142,28 @@ "type": "string" }, { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" } ], @@ -101027,16 +103172,31 @@ ], "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 domain ID of the security group", - "name": "domainid", + "description": "the description of the security group", + "name": "description", + "type": "string" + }, + { + "description": "the project name of the group", + "name": "project", "type": "string" }, + { + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" + }, { "description": "the name of the security group", "name": "name", @@ -101046,88 +103206,68 @@ "description": "the list of ingress rules associated with the security group", "name": "ingressrule", "response": [ - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the 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": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "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" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" } ], "type": "set" }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, { "description": "the ending IP of the security group rule ", "name": "endport", @@ -101139,21 +103279,46 @@ "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" + }, + { + "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" } ], "type": "set" }, { - "description": "the description of the security group", - "name": "description", + "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" }, { @@ -101161,8 +103326,8 @@ "name": "tags", "response": [ { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "tag value", + "name": "value", "type": "string" }, { @@ -101171,145 +103336,162 @@ "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" }, { - "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": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" } ], "type": "set" }, + { + "description": "the domain name of the security group", + "name": "domain", + "type": "string" + }, { "description": "the account owning the security group", "name": "account", "type": "string" + } + ], + "type": "set" + }, + { + "description": "Guest vm Boot Mode", + "name": "bootmode", + "type": "string" + }, + { + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "resource type", + "name": "resourcetype", + "type": "string" }, { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" }, { - "description": "the project id of the group", + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the project id the tag belongs to", "name": "projectid", "type": "string" }, { - "description": "the project name of the group", - "name": "project", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the domain name of the security group", + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the domain associated with the tag", "name": "domain", "type": "string" }, { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" + "description": "customer associated with the tag", + "name": "customer", + "type": "string" } ], "type": "set" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", - "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": "Vm details in key/value pairs.", - "name": "details", - "type": "map" - }, - { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", - "type": "string" - }, - { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", - "type": "boolean" - }, - { - "description": "ssh key-pair", - "name": "keypair", + "description": "the project name of the vm", + "name": "project", "type": "string" }, { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", + "description": "the group ID of the virtual machine", + "name": "groupid", "type": "string" }, { - "description": "the target memory in vm", - "name": "memorytargetkbs", - "type": "long" - }, - { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", "type": "string" }, { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", + "description": "the group name of the virtual machine", + "name": "group", "type": "string" }, { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", + "description": "the password (if exists) of the virtual machine", + "name": "password", "type": "string" }, { - "description": "the name of the disk offering of the virtual machine", - "name": "diskofferingname", - "type": "string" + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" }, { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "device ID of the root volume", @@ -101317,322 +103499,219 @@ "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 number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" }, { - "description": "the vgpu type used by the virtual machine", - "name": "vgpu", - "type": "string" + "description": "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 ID of the host for the virtual machine", + "name": "hostid", "type": "string" }, { - "description": "the ID of the virtual machine", - "name": "id", + "description": "the user's ID who deployed the virtual machine", + "name": "userid", "type": "string" }, { - "description": "the speed of each cpu", - "name": "cpuspeed", - "type": "integer" + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" }, + {}, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "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": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" }, { "description": "the ID of the availablility zone for the virtual machine", "name": "zoneid", "type": "string" }, - {}, { - "description": "the name of the virtual machine", - "name": "name", + "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", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, { - "description": "the write (io) of disk on the vm", - "name": "diskiowrite", - "type": "long" - }, - { - "description": "State of the Service from LB rule", - "name": "servicestate", - "type": "string" + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", + "type": "boolean" }, - {}, { - "description": "the memory used by the vm", - "name": "memorykbs", - "type": "long" + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "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": "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" }, { - "description": "OS name of the vm", - "name": "osdisplayname", - "type": "string" + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" }, { - "description": "the read (io) of disk on the vm", - "name": "diskioread", + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", "type": "long" }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, { "description": "the memory allocated for the virtual machine", "name": "memory", "type": "integer" }, { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "the account associated with the virtual machine", + "name": "account", "type": "string" }, { - "description": "the number of cpu this virtual machine is running with", - "name": "cpunumber", - "type": "integer" - }, - { - "description": "the state of the virtual machine", - "name": "state", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the user's name who deployed the virtual machine", - "name": "username", + "description": "the ID of the disk offering of the virtual machine", + "name": "diskofferingid", "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": "the write (bytes) of disk on the vm", - "name": "diskkbswrite", - "type": "long" - }, - { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "the project id of the vm", - "name": "projectid", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "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 name of the affinity group", - "name": "domain", - "type": "string" - }, - { - "description": "the project name of the affinity group", - "name": "project", - "type": "string" - }, - { - "description": "the type of the affinity group", - "name": "type", - "type": "string" - }, - { - "description": "the domain ID of the affinity group", - "name": "domainid", - "type": "string" - }, - { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" - }, - { - "description": "the ID of the affinity group", - "name": "id", - "type": "string" - }, - { - "description": "the project ID of the affinity group", - "name": "projectid", - "type": "string" - }, - { - "description": "the description of the affinity group", - "name": "description", - "type": "string" - }, - { - "description": "the name of the affinity group", - "name": "name", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the account associated with the virtual machine", - "name": "account", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", - "type": "boolean" + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "the name of the disk offering of the virtual machine", + "name": "diskofferingname", "type": "string" }, { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", "type": "string" }, { - "description": "the incoming network traffic on the vm", - "name": "networkkbsread", - "type": "long" - }, - { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" - }, - { - "description": "the password (if exists) of the virtual machine", - "name": "password", + "description": "OS name of the vm", + "name": "osdisplayname", "type": "string" }, - { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" - }, { "description": "the list of nics associated with vm", "name": "nic", "response": [ { - "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": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", "type": "string" }, { - "description": "the ID of the nic", - "name": "id", + "description": "the isolation uri of the nic", + "name": "isolationuri", "type": "string" }, { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" - }, - { - "description": "the netmask of the nic", - "name": "netmask", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "the IPv6 address of network", + "name": "ip6address", "type": "string" }, { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" + "description": "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 ID of the corresponding network", + "name": "networkid", + "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": "Type of adapter if available", - "name": "adaptertype", + "description": "the ip address of the nic", + "name": "ipaddress", "type": "string" }, { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" + "description": "the name of the corresponding network", + "name": "networkname", + "type": "string" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "the type of the nic", + "name": "type", "type": "string" }, { - "description": "the ID of the corresponding network", - "name": "networkid", - "type": "string" + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" }, { "description": "true if nic is default, false otherwise", @@ -101640,365 +103719,186 @@ "type": "string" }, { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" + }, + { + "description": "the netmask of the nic", + "name": "netmask", "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 isolation uri of the nic", - "name": "isolationuri", + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { - "description": "the type of the nic", - "name": "type", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", "type": "string" }, { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", "type": "string" }, { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", - "type": "string" + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" }, { - "description": "the ip address of the nic", - "name": "ipaddress", + "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": "the broadcast uri of the nic", + "name": "broadcasturi", "type": "string" }, { - "description": "the gateway of the nic", - "name": "gateway", + "description": "the ID of the nic", + "name": "id", "type": "string" - } - ], - "type": "set" - }, - { - "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 name of the ISO attached to the virtual machine", - "name": "isoname", - "type": "string" - } - ], - "since": "4.14.0" - }, - { - "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 name of the physical network", - "length": 255, - "name": "name", - "required": true, - "type": "string" + }, + { + "description": "the traffic type of the nic", + "name": "traffictype", + "type": "string" + }, + { + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + } + ], + "type": "set" }, { - "description": "the broadcast domain range for the physical network[Pod or Zone]. In Acton release it can be Zone only in Advance zone, and Pod in Basic", - "length": 255, - "name": "broadcastdomainrange", - "required": false, - "type": "string" + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" }, { - "description": "the speed for the physical network[1G/10G]", - "length": 255, - "name": "networkspeed", - "required": false, + "description": "ssh key-pairs", + "name": "keypairs", "type": "string" }, { - "description": "domain ID of the account owning a physical network", - "length": 255, - "name": "domainid", - "related": "listDomains", - "required": false, - "type": "uuid" - }, - { - "description": "Tag the physical network", - "length": 255, - "name": "tags", - "required": false, - "type": "list" - }, - { - "description": "the isolation method for the physical network[VLAN/L3/GRE]", - "length": 255, - "name": "isolationmethods", - "required": false, - "type": "list" + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" }, { - "description": "the VLAN for the physical network", - "length": 255, - "name": "vlan", - "required": false, - "type": "string" - } - ], - "related": "", - "response": [ - { - "description": "isolation methods", - "name": "isolationmethods", - "type": "string" + "description": "the read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" }, { - "description": "the vlan of the physical network", - "name": "vlan", + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", "type": "string" }, - {}, { - "description": "state of the physical network", - "name": "state", + "description": "the pool type of the virtual machine", + "name": "pooltype", "type": "string" }, { - "description": "name of the physical network", - "name": "name", + "description": "device type of the root volume", + "name": "rootdevicetype", "type": "string" }, - {}, { - "description": "the speed of the physical network", - "name": "networkspeed", - "type": "string" + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the name of the host for the virtual machine", + "name": "hostname", "type": "string" }, { - "description": "zone name of the physical network", - "name": "zonename", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "comma separated tag", - "name": "tags", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "Broadcast domain range of the physical network", - "name": "broadcastdomainrange", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "description": "the uuid of the physical network", - "name": "id", - "type": "string" + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" }, { - "description": "zone id of the physical network", - "name": "zoneid", - "type": "string" + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", + "type": "long" }, { - "description": "the domain id of the physical network owner", - "name": "domainid", + "description": "the project id of the vm", + "name": "projectid", "type": "string" } ], - "since": "3.0.0" + "since": "4.14.0" }, { - "description": "Lists autoscale vm groups.", - "isasync": false, - "name": "listAutoScaleVmGroups", + "description": "Deletes a IPv6 firewall rule", + "isasync": true, + "name": "deleteIpv6FirewallRule", "params": [ { - "description": "the ID of the autoscale vm group", + "description": "the ID of the IPv6 firewall rule", "length": 255, "name": "id", - "related": "listAutoScaleVmGroups", - "required": false, - "type": "uuid" - }, - { - "description": "list only resources belonging to the domain specified", - "length": 255, - "name": "domainid", - "related": "listDomains", - "required": false, - "type": "uuid" - }, - { - "description": "list objects by project", - "length": 255, - "name": "projectid", - "related": "activateProject", - "required": false, - "type": "uuid" - }, - { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, - { - "description": "the ID of the profile", - "length": 255, - "name": "vmprofileid", - "related": "createAutoScaleVmProfile", - "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": "list resources by account. Must be used with the domainId parameter.", - "length": 255, - "name": "account", - "required": false, - "type": "string" - }, - { - "description": "the ID of the loadbalancer", - "length": 255, - "name": "lbruleid", - "related": "", - "required": false, - "type": "uuid" - }, - { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, - { - "description": "the availability zone ID", - "length": 255, - "name": "zoneid", - "related": "listZones", - "required": false, - "type": "uuid" - }, - { - "description": "the ID of the policy", - "length": 255, - "name": "policyid", "related": "", - "required": false, + "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", - "length": 255, - "name": "listall", - "required": false, - "type": "boolean" - }, - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - }, - { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", - "length": 255, - "name": "isrecursive", - "required": false, - "type": "boolean" } ], - "related": "", "response": [ + {}, { - "description": "the project id vm profile", - "name": "projectid", - "type": "string" - }, - { - "description": "the domain name of the vm profile", - "name": "domain", - "type": "string" - }, - { - "description": "the domain ID of the vm profile", - "name": "domainid", - "type": "string" - }, - { - "description": "the minimum number of members in the vmgroup, the number of instances in the vm group will be equal to or more than this number.", - "name": "minmembers", - "type": "int" - }, - { - "description": "the project name of the vm profile", - "name": "project", - "type": "string" - }, - { - "description": "the autoscale profile that contains information about the vms in the vm group.", - "name": "vmprofileid", - "type": "string" - }, - { - "description": "the load balancer rule ID", - "name": "lbruleid", - "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", @@ -102006,204 +103906,113 @@ "type": "string" }, { - "description": "the account owning the instance group", - "name": "account", - "type": "string" - }, - { - "description": "the frequency at which the conditions have to be evaluated", - "name": "interval", - "type": "int" - }, - { - "description": "the autoscale vm group ID", - "name": "id", + "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 of scaledown autoscale policies", - "name": "scaledownpolicies", - "type": "list" - }, - { - "description": "list of scaleup autoscale policies", - "name": "scaleuppolicies", - "type": "list" - }, - { - "description": "the current state of the AutoScale Vm Group", - "name": "state", - "type": "string" - }, - { - "description": "the maximum number of members in the vmgroup, The number of instances in the vm group will be equal to or less than this number.", - "name": "maxmembers", - "type": "int" - }, - { - "description": "is group for display to the regular user", - "name": "fordisplay", - "type": "boolean" - }, - {} + } ] }, { - "description": "Creates a firewall rule for a given IP address", + "description": "Creates a physical network", "isasync": true, - "name": "createFirewallRule", + "name": "createPhysicalNetwork", "params": [ { - "description": "error code for this icmp message", + "description": "Tag the physical network", "length": 255, - "name": "icmpcode", + "name": "tags", "required": false, - "type": "integer" + "type": "list" }, { - "description": "the IP address id of the port forwarding rule", + "description": "the name of the physical network", "length": 255, - "name": "ipaddressid", - "related": "associateIpAddress,listPublicIpAddresses", + "name": "name", "required": true, - "type": "uuid" + "type": "string" }, { - "description": "type of the ICMP message being sent", + "description": "the VLAN for the physical network", "length": 255, - "name": "icmptype", + "name": "vlan", "required": false, - "type": "integer" + "type": "string" }, { - "description": "the ending port of firewall rule", + "description": "the Zone ID for the physical network", "length": 255, - "name": "endport", - "required": false, - "type": "integer" + "name": "zoneid", + "related": "listZones", + "required": true, + "type": "uuid" }, { - "description": "the starting port of firewall rule", + "description": "domain ID of the account owning a physical network", "length": 255, - "name": "startport", + "name": "domainid", + "related": "listDomains", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "an optional field, whether to the display the rule to the end user or not", + "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": "fordisplay", + "name": "broadcastdomainrange", "required": false, - "since": "4.4", - "type": "boolean" + "type": "string" }, { - "description": "the CIDR list to forward traffic from. Multiple entries must be separated by a single comma character (,).", + "description": "the isolation method for the physical network[VLAN/L3/GRE]", "length": 255, - "name": "cidrlist", + "name": "isolationmethods", "required": false, "type": "list" }, { - "description": "the protocol for the firewall rule. Valid values are TCP/UDP/ICMP.", - "length": 255, - "name": "protocol", - "required": true, - "type": "string" - }, - { - "description": "type of firewallrule: system/user", + "description": "the speed for the physical network[1G/10G]", "length": 255, - "name": "type", + "name": "networkspeed", "required": false, "type": "string" } ], - "related": "updateEgressFirewallRule", + "related": "", "response": [ { - "description": "the cidr list to forward traffic to. Multiple entries are separated by a single comma character (,).", - "name": "destcidrlist", + "description": "state of the physical network", + "name": "state", "type": "string" }, { - "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", + "description": "comma separated tag", + "name": "tags", "type": "string" }, { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "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", + "name": "jobid", + "type": "string" }, - {}, { - "description": "the starting port of firewall rule's port range", - "name": "startport", - "type": "integer" + "description": "isolation methods", + "name": "isolationmethods", + "type": "string" }, { - "description": "error code for this icmp message", - "name": "icmpcode", - "type": "integer" + "description": "the speed of the physical network", + "name": "networkspeed", + "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", @@ -102211,489 +104020,349 @@ "type": "integer" }, { - "description": "the public ip address for the firewall rule", - "name": "ipaddress", + "description": "Broadcast domain range of the physical network", + "name": "broadcastdomainrange", "type": "string" }, { - "description": "the protocol of the firewall rule", - "name": "protocol", + "description": "name of the physical network", + "name": "name", "type": "string" }, { - "description": "the state of the rule", - "name": "state", + "description": "the domain id of the physical network owner", + "name": "domainid", "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 ID of the firewall rule", + "description": "the uuid of the physical network", "name": "id", "type": "string" }, { - "description": "the public ip address id for the firewall rule", - "name": "ipaddressid", - "type": "string" - }, - { - "description": "is rule for display to the regular user", - "name": "fordisplay", - "type": "boolean" - }, - { - "description": "the ending port of firewall rule's port range", - "name": "endport", - "type": "integer" - }, - { - "description": "type of the icmp message being sent", - "name": "icmptype", - "type": "integer" - }, - { - "description": "the network id of the firewall rule", - "name": "networkid", + "description": "zone name of the physical network", + "name": "zonename", "type": "string" }, {} - ] + ], + "since": "3.0.0" }, { - "description": "Creates a disk volume from a disk offering. This disk volume must still be attached to a virtual machine to make use of it.", - "isasync": true, - "name": "createVolume", + "description": "Lists autoscale vm groups.", + "isasync": false, + "name": "listAutoScaleVmGroups", "params": [ { - "description": "the snapshot ID for the disk volume. Either diskOfferingId or snapshotId must be passed in.", + "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 loadbalancer", "length": 255, - "name": "snapshotid", + "name": "lbruleid", "related": "", "required": false, "type": "uuid" }, { - "description": "the name of the disk volume", + "description": "", "length": 255, - "name": "name", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { - "description": "the ID of the disk offering. Either diskOfferingId or snapshotId must be passed in.", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "diskofferingid", - "related": "", + "name": "domainid", + "related": "listDomains", "required": false, "type": "uuid" }, { - "description": "the ID of the availability zone", + "description": "the ID of the policy", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "policyid", + "related": "", "required": false, "type": "uuid" }, { - "description": "the project associated with the volume. Mutually exclusive with account parameter", + "description": "the ID of the autoscale vm group", "length": 255, - "name": "projectid", - "related": "activateProject", + "name": "id", + "related": "listAutoScaleVmGroups", "required": false, "type": "uuid" }, { - "description": "max iops", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "maxiops", + "name": "projectid", + "related": "activateProject", "required": false, - "type": "long" + "type": "uuid" }, { - "description": "the account associated with the disk volume. Must be used with the domainId parameter.", + "description": "the ID of the profile", "length": 255, - "name": "account", + "name": "vmprofileid", + "related": "createAutoScaleVmProfile", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "an optional field, whether to display the volume to the end user or not.", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "displayvolume", + "name": "isrecursive", "required": false, "type": "boolean" }, { - "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", + "description": "", "length": 255, - "name": "customid", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { - "description": "the ID of the virtual machine; to be used with snapshot Id, VM to which the volume gets attached after creation", + "description": "the availability zone ID", "length": 255, - "name": "virtualmachineid", - "related": "attachIso,destroyVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,startVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines", + "name": "zoneid", + "related": "listZones", "required": false, "type": "uuid" }, { - "description": "the domain ID associated with the disk offering. If used with the account parameter returns the disk volume associated with the account for the specified domain.", + "description": "List by keyword", "length": 255, - "name": "domainid", - "related": "listDomains", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "min iops", + "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", "length": 255, - "name": "miniops", + "name": "fordisplay", "required": false, - "type": "long" + "since": "4.4", + "type": "boolean" }, { - "description": "Arbitrary volume size", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "size", + "name": "listall", "required": false, - "type": "long" + "type": "boolean" } ], - "related": "attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", + "related": "", "response": [ { - "description": "state of the virtual machine", - "name": "vmstate", - "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 ID of 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 read (io) of disk on the vm", - "name": "diskioread", - "type": "long" - }, - { - "description": "name of the virtual machine", - "name": "vmname", - "type": "string" - }, - { - "description": "io requests write rate of the disk volume per the disk offering", - "name": "diskIopsWriteRate", - "type": "long" - }, - { - "description": "shared or local storage", - "name": "storagetype", - "type": "string" - }, - { - "description": "the boolean state of whether the volume is destroyed or not", - "name": "destroyed", + "description": "is group for display to the regular user", + "name": "fordisplay", "type": "boolean" }, { - "description": "ID of the service offering for root disk", - "name": "serviceofferingid", - "type": "string" - }, - { - "description": "pod name of the volume", - "name": "podname", - "type": "string" - }, - { - "description": "ID of the disk volume", - "name": "id", - "type": "string" - }, - { - "description": "the state of the disk volume", - "name": "state", - "type": "string" - }, - { - "description": "cluster id of the volume", - "name": "clusterid", - "type": "string" + "description": "list of scaledown autoscale policies", + "name": "scaledownpolicies", + "type": "list" }, { - "description": "id of the virtual machine", - "name": "virtualmachineid", + "description": "the load balancer rule ID", + "name": "lbruleid", "type": "string" }, { - "description": "name of the disk volume", - "name": "name", + "description": "the project name of the vm profile", + "name": "project", "type": "string" }, { - "description": "bytes write rate of the disk volume", - "name": "diskBytesWriteRate", - "type": "long" - }, - { - "description": "name of the service offering for root disk", - "name": "serviceofferingname", + "description": "the domain ID of the vm profile", + "name": "domainid", "type": "string" }, { - "description": "Hypervisor the volume belongs to", - "name": "hypervisor", + "description": "the autoscale profile that contains information about the vms in the vm group.", + "name": "vmprofileid", "type": "string" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", - "type": "string" + "description": "the frequency at which the conditions have to be evaluated", + "name": "interval", + "type": "int" }, { - "description": "display name of the virtual machine", - "name": "vmdisplayname", + "description": "the project id vm profile", + "name": "projectid", "type": "string" }, { - "description": "true if the volume is extractable, false otherwise", - "name": "isextractable", - "type": "boolean" - }, - { - "description": "the domain associated with the disk volume", + "description": "the domain name of the vm profile", "name": "domain", "type": "string" }, { - "description": "the chain info of the volume", - "name": "chaininfo", + "description": "the current state of the AutoScale Vm Group", + "name": "state", "type": "string" }, { - "description": "the read (bytes) of disk on the vm", - "name": "diskkbsread", - "type": "long" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "ID of the snapshot from which this volume was created", - "name": "snapshotid", + "description": "the autoscale vm group ID", + "name": "id", "type": "string" }, { - "description": "the bytes actually consumed on disk", - "name": "virtualsize", - "type": "long" + "description": "list of scaleup autoscale policies", + "name": "scaleuppolicies", + "type": "list" }, { - "description": "the account associated with the disk volume", - "name": "account", - "type": "string" + "description": "the minimum number of members in the vmgroup, the number of instances in the vm group will be equal to or more than this number.", + "name": "minmembers", + "type": "int" }, + {}, { "description": "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", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, { - "description": "the bytes allocated", - "name": "physicalsize", - "type": "long" + "description": "the maximum number of members in the vmgroup, The number of instances in the vm group will be equal to or less than this number.", + "name": "maxmembers", + "type": "int" }, { - "description": "the project name of the vpn", - "name": "project", + "description": "the account owning the instance group", + "name": "account", "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 key name", - "name": "key", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "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": "id of the resource", - "name": "resourceid", - "type": "string" - } - ], - "type": "set" - }, + } + ] + }, + { + "description": "Creates a firewall rule for a given IP address", + "isasync": true, + "name": "createFirewallRule", + "params": [ { - "description": "the project id of the vpn", - "name": "projectid", - "type": "string" + "description": "the ending port of firewall rule", + "length": 255, + "name": "endport", + "required": false, + "type": "integer" }, { - "description": "name of the disk offering", - "name": "diskofferingname", + "description": "type of firewallrule: system/user", + "length": 255, + "name": "type", + "required": false, "type": "string" }, { - "description": "true if storage snapshot is supported for the volume, false otherwise", - "name": "supportsstoragesnapshot", + "description": "an optional field, whether to the display the rule to the end user or not", + "length": 255, + "name": "fordisplay", + "required": false, + "since": "4.4", "type": "boolean" }, { - "description": "cluster name where the volume is allocated", - "name": "clustername", - "type": "string" - }, - { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", - "type": "string" - }, - { - "description": "name of the availability zone", - "name": "zonename", - "type": "string" - }, - { - "description": "ID of the disk offering", - "name": "diskofferingid", - "type": "string" - }, - { - "description": "the disk utilization", - "name": "utilization", - "type": "string" - }, - { - "description": "pod id of the volume", - "name": "podid", + "description": "the protocol for the firewall rule. Valid values are TCP/UDP/ICMP.", + "length": 255, + "name": "protocol", + "required": true, "type": "string" }, { - "description": "bytes read rate of the disk volume", - "name": "diskBytesReadRate", - "type": "long" + "description": "the IP address id of the port forwarding rule", + "length": 255, + "name": "ipaddressid", + "related": "associateIpAddress,listPublicIpAddresses", + "required": true, + "type": "uuid" }, { - "description": "min iops of the disk volume", - "name": "miniops", - "type": "long" + "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 date the disk volume was created", - "name": "created", - "type": "date" + "description": "type of the ICMP message being sent", + "length": 255, + "name": "icmptype", + "required": false, + "type": "integer" }, { - "description": "max iops of the disk volume", - "name": "maxiops", - "type": "long" + "description": "the starting port of firewall rule", + "length": 255, + "name": "startport", + "required": false, + "type": "integer" }, { - "description": "name of the primary storage hosting the disk volume", - "name": "storage", - "type": "string" - }, + "description": "error code for this icmp message", + "length": 255, + "name": "icmpcode", + "required": false, + "type": "integer" + } + ], + "related": "updateEgressFirewallRule", + "response": [ { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "the public ip address id for the firewall rule", + "name": "ipaddressid", "type": "string" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", "type": "string" }, { - "description": "an optional field whether to the display the volume to the end user or not.", - "name": "displayvolume", + "description": "is rule for display to the regular user", + "name": "fordisplay", "type": "boolean" }, { - "description": "the date the volume was attached to a VM instance", - "name": "attached", - "type": "date" + "description": "the ending port of firewall rule's port range", + "name": "endport", + "type": "integer" }, { - "description": "need quiesce vm or not when taking snapshot", - "name": "quiescevm", - "type": "boolean" + "description": "the cidr list to forward traffic to. Multiple entries are separated by a single comma character (,).", + "name": "destcidrlist", + "type": "string" }, { - "description": "type of the disk volume (ROOT or DATADISK)", - "name": "type", - "type": "string" + "description": "type of the icmp message being sent", + "name": "icmptype", + "type": "integer" }, { - "description": "the path of the volume", - "name": "path", + "description": "the network id of the firewall rule", + "name": "networkid", "type": "string" }, { @@ -102702,117 +104371,53 @@ "type": "integer" }, { - "description": "ID of the availability zone", - "name": "zoneid", - "type": "string" - }, - { - "description": "id of the primary storage hosting the disk volume; returned to admin user only", - "name": "storageid", + "description": "the ID of the firewall rule", + "name": "id", "type": "string" }, { - "description": "io requests read rate of the disk volume per the disk offering", - "name": "diskIopsReadRate", - "type": "long" - }, - { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "the protocol of the firewall rule", + "name": "protocol", "type": "string" }, { - "description": "the write (bytes) of disk on the vm", - "name": "diskkbswrite", - "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": "size of the disk volume", - "name": "size", - "type": "long" - }, - { - "description": "the ID of the domain associated with the disk volume", - "name": "domainid", + "description": "the state of the rule", + "name": "state", "type": "string" }, { - "description": "the display text of the disk offering", - "name": "diskofferingdisplaytext", + "description": "the traffic type for the firewall rule", + "name": "traffictype", "type": "string" }, { - "description": "provisioning type used to create volumes.", - "name": "provisioningtype", - "type": "string" - } - ] - }, - { - "description": "lists network that are using a F5 load balancer device", - "isasync": false, - "name": "listF5LoadBalancerNetworks", - "params": [ - { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, + "description": "the starting port of firewall rule's port range", + "name": "startport", "type": "integer" }, { - "description": "f5 load balancer device ID", - "length": 255, - "name": "lbdeviceid", - "related": "", - "required": true, - "type": "uuid" - }, - { - "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, - "type": "integer" - } - ], - "related": "createNetwork,updateNetwork,listNetworks", - "response": [ - { - "description": "true if users from subdomains can access the domain level network", - "name": "subdomainaccess", - "type": "boolean" + "description": "the public ip address for the firewall rule", + "name": "ipaddress", + "type": "string" }, { - "description": "the list of resource tags associated with network", + "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { @@ -102821,13 +104426,13 @@ "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { @@ -102836,8 +104441,8 @@ "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "tag value", + "name": "value", "type": "string" }, { @@ -102846,142 +104451,194 @@ "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", "type": "string" } ], "type": "list" }, { - "description": "network offering id the network is created from", - "name": "networkofferingid", - "type": "string" + "description": "error code for this icmp message", + "name": "icmpcode", + "type": "integer" }, + {} + ] + }, + { + "description": "Creates a disk volume from a disk offering. This disk volume must still be attached to a virtual machine to make use of it.", + "isasync": true, + "name": "createVolume", + "params": [ { - "description": "the details of the network", - "name": "details", - "type": "map" + "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", + "length": 255, + "name": "customid", + "required": false, + "type": "string" }, { - "description": "The vlan of the network. This parameter is visible to ROOT admins only", - "name": "vlan", + "description": "the account associated with the disk volume. Must be used with the domainId parameter.", + "length": 255, + "name": "account", + "required": false, "type": "string" }, { - "description": "If the network has redundant routers enabled", - "name": "redundantrouter", - "type": "boolean" + "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 name of the zone the network belongs to", - "name": "zonename", - "type": "string" + "description": "the domain ID associated with the disk offering. If used with the account parameter returns the disk volume associated with the account for the specified domain.", + "length": 255, + "name": "domainid", + "related": "listDomains", + "required": false, + "type": "uuid" }, { - "description": "list networks that are persistent", - "name": "ispersistent", + "description": "an optional field, whether to display the volume to the end user or not.", + "length": 255, + "name": "displayvolume", + "required": false, "type": "boolean" }, { - "description": "state of the network", - "name": "state", - "type": "string" + "description": "the ID of the disk offering. Either diskOfferingId or snapshotId must be passed in.", + "length": 255, + "name": "diskofferingid", + "related": "", + "required": false, + "type": "uuid" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", + "description": "the ID of the availability zone", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": false, + "type": "uuid" + }, + { + "description": "min iops", + "length": 255, + "name": "miniops", + "required": false, "type": "long" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", - "type": "string" + "description": "Arbitrary volume size", + "length": 255, + "name": "size", + "required": false, + "type": "long" }, { - "description": "the project id of the ipaddress", + "description": "the project associated with the volume. Mutually exclusive with account parameter", + "length": 255, "name": "projectid", - "type": "string" + "related": "activateProject", + "required": false, + "type": "uuid" }, { - "description": "true if network is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "max iops", + "length": 255, + "name": "maxiops", + "required": false, + "type": "long" }, { - "description": "an optional field, whether to the display the network to the end user or not.", - "name": "displaynetwork", - "type": "boolean" + "description": "the name of the disk volume", + "length": 255, + "name": "name", + "required": false, + "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "the ID of the virtual machine; to be used with snapshot Id, VM to which the volume gets attached after creation", + "length": 255, + "name": "virtualmachineid", + "related": "attachIso,destroyVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,startVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines", + "required": false, + "type": "uuid" + } + ], + "related": "attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", + "response": [ + { + "description": "the display text of the disk offering", + "name": "diskofferingdisplaytext", "type": "string" }, { - "description": "zone id of the network", - "name": "zoneid", + "description": "shared or local storage", + "name": "storagetype", "type": "string" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" + "description": "an optional field whether to the display the volume to the end user or not.", + "name": "displayvolume", + "type": "boolean" }, { - "description": "The external id of the network", - "name": "externalid", - "type": "string" + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" }, { - "description": "the displaytext of the network", - "name": "displaytext", - "type": "string" + "description": "true if storage snapshot is supported for the volume, false otherwise", + "name": "supportsstoragesnapshot", + "type": "boolean" }, { - "description": "the id of the network", - "name": "id", + "description": "ID of the service offering for root disk", + "name": "serviceofferingid", "type": "string" }, - {}, { - "description": "Broadcast domain type of the network", - "name": "broadcastdomaintype", - "type": "string" + "description": "IO requests read rate of the disk volume per the disk offering", + "name": "diskIopsReadRate", + "type": "long" }, { - "description": "the network's gateway", - "name": "gateway", + "description": "name of the disk offering", + "name": "diskofferingname", "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": "name of the availability zone", + "name": "zonename", "type": "string" }, { - "description": "true if network is system, false otherwise", - "name": "issystem", - "type": "boolean" - }, - { - "description": "the type of the network", - "name": "type", - "type": "string" + "description": "max iops of the disk volume", + "name": "maxiops", + "type": "long" }, { - "description": "availability of the network offering the network is created from", - "name": "networkofferingavailability", + "description": "id of the virtual machine", + "name": "virtualmachineid", "type": "string" }, { - "description": "the domain id of the network owner", - "name": "domainid", + "description": "name of the primary storage hosting the disk volume", + "name": "storage", "type": "string" }, { - "description": "broadcast uri of the network. This parameter is visible to ROOT admins only", - "name": "broadcasturi", + "description": "the display text of the service offering for root disk", + "name": "serviceofferingdisplaytext", "type": "string" }, { @@ -102989,231 +104646,323 @@ "name": "jobstatus", "type": "integer" }, + {}, { - "description": "the network's IP range not to be used by CloudStack guest VMs and can be used for non CloudStack purposes", - "name": "reservediprange", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "true network requires restart", - "name": "restartrequired", - "type": "boolean" + "description": "provisioning type used to create volumes.", + "name": "provisioningtype", + "type": "string" }, { - "description": "true if network supports specifying ip ranges, false otherwise", - "name": "specifyipranges", - "type": "boolean" + "description": "the path of the volume", + "name": "path", + "type": "string" }, { - "description": "the physical network id", - "name": "physicalnetworkid", + "description": "the ID of 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": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR", - "name": "cidr", + "description": "volume uuid that is given by virtualisation provider (only for VMware)", + "name": "externaluuid", "type": "string" }, - {}, { - "description": "the date this network was created", - "name": "created", - "type": "date" + "description": "cluster name where the volume is allocated", + "name": "clustername", + "type": "string" }, { - "description": "true if network offering is ip conserve mode enabled", - "name": "networkofferingconservemode", + "description": "the boolean state of whether the volume is destroyed or not", + "name": "destroyed", "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "description": "acl type - access type to the network", - "name": "acltype", - "type": "string" + "description": "min iops of the disk volume", + "name": "miniops", + "type": "long" }, { - "description": "ACL Id associated with the VPC network", - "name": "aclid", + "description": "the project name of the vpn", + "name": "project", "type": "string" }, { - "description": "the network's netmask", - "name": "netmask", - "type": "string" + "description": "the write (IO) of disk on the vm", + "name": "diskiowrite", + "type": "long" }, { - "description": "the project name of the address", - "name": "project", - "type": "string" + "description": "size of the disk volume", + "name": "size", + "type": "long" }, { - "description": "display text of the network offering the network is created from", - "name": "networkofferingdisplaytext", - "type": "string" + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" }, { - "description": "ACL name associated with the VPC network", - "name": "aclname", + "description": "name of the virtual machine", + "name": "vmname", "type": "string" }, { - "description": "the network domain", - "name": "networkdomain", + "description": "cluster id of the volume", + "name": "clusterid", "type": "string" }, { - "description": "name of the network offering the network is created from", - "name": "networkofferingname", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "VPC the network belongs to", - "name": "vpcid", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "related to what other network configuration", - "name": "related", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the owner of the network", - "name": "account", - "type": "string" + "description": "the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached.", + "name": "deviceid", + "type": "long" }, { - "description": "the traffic type of the network", - "name": "traffictype", + "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": "IO requests write rate of the disk volume per the disk offering", + "name": "diskIopsWriteRate", + "type": "long" }, { - "description": "the first DNS for the network", - "name": "dns1", + "description": "the read (IO) of disk on the vm", + "name": "diskioread", + "type": "long" + }, + { + "description": "name of the service offering for root disk", + "name": "serviceofferingname", "type": "string" }, { - "description": "the second DNS for the network", - "name": "dns2", + "description": "the project id of the vpn", + "name": "projectid", "type": "string" }, { - "description": "true if network can span multiple zones", - "name": "strechedl2subnet", + "description": "need quiesce vm or not when taking snapshot", + "name": "quiescevm", "type": "boolean" }, { - "description": "the name of the network", - "name": "name", + "description": "display name of the virtual machine", + "name": "vmdisplayname", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "bytes write rate of the disk volume", + "name": "diskBytesWriteRate", + "type": "long" }, { - "description": "the list of services", - "name": "service", + "description": "the list of resource tags associated", + "name": "tags", "response": [ { - "description": "the service provider name", - "name": "provider", - "response": [ - { - "description": "true if individual services can be enabled/disabled", - "name": "canenableindividualservice", - "type": "boolean" - }, - { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", - "type": "string" - }, - { - "description": "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 destination physical network", - "name": "destinationphysicalnetworkid", - "type": "string" - }, - { - "description": "state of the network provider", - "name": "state", - "type": "string" - } - ], - "type": "list" + "description": "id of the resource", + "name": "resourceid", + "type": "string" }, { - "description": "the service name", - "name": "name", + "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": "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 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": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" } ], - "type": "list" + "type": "set" + }, + { + "description": "type of the disk volume (ROOT or DATADISK)", + "name": "type", + "type": "string" + }, + { + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", + "type": "string" + }, + { + "description": "the bytes allocated", + "name": "physicalsize", + "type": "long" + }, + { + "description": "bytes read rate of the disk volume", + "name": "diskBytesReadRate", + "type": "long" + }, + { + "description": "the date the disk volume was created", + "name": "created", + "type": "date" + }, + { + "description": "the disk utilization", + "name": "utilization", + "type": "string" + }, + { + "description": "name of the disk volume", + "name": "name", + "type": "string" + }, + { + "description": "ID of the disk offering", + "name": "diskofferingid", + "type": "string" + }, + { + "description": "pod name of the volume", + "name": "podname", + "type": "string" + }, + { + "description": "ID of the snapshot from which this volume was created", + "name": "snapshotid", + "type": "string" + }, + { + "description": "the bytes actually consumed on disk", + "name": "virtualsize", + "type": "long" }, { - "description": "the domain name of the network owner", - "name": "domain", + "description": "Hypervisor the volume belongs to", + "name": "hypervisor", "type": "string" }, { - "description": "list networks available for vm deployment", - "name": "canusefordeploy", + "description": "ID of the availability zone", + "name": "zoneid", + "type": "string" + }, + { + "description": "id of the primary storage hosting the disk volume; returned to admin user only", + "name": "storageid", + "type": "string" + }, + { + "description": "ID of the disk volume", + "name": "id", + "type": "string" + }, + { + "description": "the state of the disk volume", + "name": "state", + "type": "string" + }, + { + "description": "the name of the template for the virtual machine", + "name": "templatename", + "type": "string" + }, + {}, + { + "description": "true if the volume is extractable, false otherwise", + "name": "isextractable", "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": "state of the virtual machine", + "name": "vmstate", + "type": "string" }, { - "description": "Name of the VPC to which this network belongs", - "name": "vpcname", + "description": "the ID of the domain associated with the disk volume", + "name": "domainid", + "type": "string" + }, + { + "description": "the chain info of the volume", + "name": "chaininfo", + "type": "string" + }, + { + "description": "the status of the volume", + "name": "status", + "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": "pod id of the volume", + "name": "podid", "type": "string" } ] @@ -103224,35 +104973,41 @@ "name": "listVMSnapshot", "params": [ { - "description": "The ID of the VM snapshot", + "description": "the IDs of the vm snapshots, mutually exclusive with vmsnapshotid", "length": 255, - "name": "vmsnapshotid", + "name": "vmsnapshotids", "related": "listVMSnapshot,createVMSnapshot", "required": false, - "type": "uuid" + "since": "4.9", + "type": "list" }, { - "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": "listDomains", + "name": "account", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "list objects by project", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "projectid", - "related": "activateProject", + "name": "listall", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false", + "description": "lists snapshot by snapshot name or display name", "length": 255, - "name": "listall", + "name": "name", "required": false, - "type": "boolean" + "type": "string" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" }, { "description": "", @@ -103270,20 +105025,18 @@ "type": "uuid" }, { - "description": "lists snapshot by snapshot name or display name", + "description": "List resources by tags (key/value pairs)", "length": 255, - "name": "name", + "name": "tags", "required": false, - "type": "string" + "type": "map" }, { - "description": "the IDs of the vm snapshots, mutually exclusive with vmsnapshotid", + "description": "state of the virtual machine snapshot", "length": 255, - "name": "vmsnapshotids", - "related": "listVMSnapshot,createVMSnapshot", + "name": "state", "required": false, - "since": "4.9", - "type": "list" + "type": "string" }, { "description": "", @@ -103292,13 +105045,6 @@ "required": false, "type": "integer" }, - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - }, { "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, @@ -103307,34 +105053,32 @@ "type": "boolean" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "account", + "name": "projectid", + "related": "activateProject", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "List resources by tags (key/value pairs)", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "tags", + "name": "domainid", + "related": "listDomains", "required": false, - "type": "map" + "type": "uuid" }, { - "description": "state of the virtual machine snapshot", + "description": "The ID of the VM snapshot", "length": 255, - "name": "state", + "name": "vmsnapshotid", + "related": "listVMSnapshot,createVMSnapshot", "required": false, - "type": "string" + "type": "uuid" } ], "related": "createVMSnapshot", "response": [ - { - "description": "the ID of the vm snapshot", - "name": "id", - "type": "string" - }, { "description": "VM Snapshot type", "name": "type", @@ -103346,8 +105090,14 @@ "type": "string" }, { - "description": "the project id of the vpn", - "name": "projectid", + "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" }, { @@ -103356,33 +105106,79 @@ "type": "date" }, { - "description": "the project name of the vpn", - "name": "project", + "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 type of hypervisor on which snapshot is stored", + "name": "hypervisor", + "type": "hypervisortype" + }, { "description": "the state of the vm snapshot", "name": "state", "type": "state" }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the vm name of the vm snapshot", + "name": "virtualmachinename", + "type": "string" + }, { "description": "the domain associated with the disk volume", "name": "domain", "type": "string" }, + { + "description": "indiates if this is current snapshot", + "name": "current", + "type": "boolean" + }, + { + "description": "the parent ID of the vm snapshot", + "name": "parent", + "type": "string" + }, + { + "description": "the vm ID of the vm snapshot", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "the display name of the vm snapshot", + "name": "displayname", + "type": "string" + }, { "description": "the description of the vm snapshot", "name": "description", "type": "string" }, { - "description": "the ID of the domain associated with the disk volume", - "name": "domainid", + "description": "the parent displayName of the vm snapshot", + "name": "parentName", "type": "string" }, { - "description": "the vm name of the vm snapshot", - "name": "virtualmachinename", + "description": "the Zone name of the vm snapshot", + "name": "zonename", + "type": "string" + }, + { + "description": "the project name of the vpn", + "name": "project", "type": "string" }, { @@ -103390,8 +105186,8 @@ "name": "tags", "response": [ { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "tag value", + "name": "value", "type": "string" }, { @@ -103400,108 +105196,61 @@ "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": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "tag 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" } ], "type": "set" }, - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the display name of the vm snapshot", - "name": "displayname", - "type": "string" - }, - {}, - { - "description": "the type of hypervisor on which snapshot is stored", - "name": "hypervisor", - "type": "hypervisortype" - }, - { - "description": "the account associated with the disk volume", - "name": "account", - "type": "string" - }, - { - "description": "the parent displayName of the vm snapshot", - "name": "parentName", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the parent ID of the vm snapshot", - "name": "parent", - "type": "string" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "indiates if this is current snapshot", - "name": "current", - "type": "boolean" - }, { "description": "the Zone ID of the vm snapshot", "name": "zoneid", "type": "string" }, { - "description": "the vm ID of the vm snapshot", - "name": "virtualmachineid", + "description": "the ID of the vm snapshot", + "name": "id", "type": "string" }, { - "description": "the Zone name of the vm snapshot", - "name": "zonename", + "description": "the account associated with the disk volume", + "name": "account", "type": "string" } ], @@ -103513,23 +105262,16 @@ "name": "updatePod", "params": [ { - "description": "the netmask of the Pod", - "length": 255, - "name": "netmask", - "required": false, - "type": "string" - }, - { - "description": "Allocation state of this cluster for allocation of new resources", + "description": "the gateway for the Pod", "length": 255, - "name": "allocationstate", + "name": "gateway", "required": false, "type": "string" }, { - "description": "the ending IP address for the Pod", + "description": "the name of the Pod", "length": 255, - "name": "endip", + "name": "name", "required": false, "type": "string" }, @@ -103542,55 +105284,41 @@ "type": "uuid" }, { - "description": "the gateway for the Pod", + "description": "the netmask of the Pod", "length": 255, - "name": "gateway", + "name": "netmask", "required": false, "type": "string" }, { - "description": "the starting IP address for the Pod", + "description": "the ending IP address for the Pod", "length": 255, - "name": "startip", + "name": "endip", "required": false, "type": "string" }, { - "description": "the name of the Pod", + "description": "Allocation state of this cluster for allocation of new resources", "length": 255, - "name": "name", + "name": "allocationstate", + "required": false, + "type": "string" + }, + { + "description": "the starting IP address for the Pod", + "length": 255, + "name": "startip", "required": false, "type": "string" } ], "related": "createManagementNetworkIpRange", "response": [ + {}, { - "description": "the IP ranges for the Pod", - "name": "ipranges", - "response": [ - { - "description": "the ending IP for the range", - "name": "endip", - "type": "string" - }, - { - "description": "indicates Vlan ID for the range", - "name": "vlanid", - "type": "string" - }, - { - "description": "indicates if range is dedicated for CPVM and SSVM", - "name": "forsystemvms", - "type": "string" - }, - { - "description": "the starting IP for the range", - "name": "startip", - "type": "string" - } - ], - "type": "list" + "description": "the ID of the Pod", + "name": "id", + "type": "string" }, { "description": "the UUID of the latest async job acting on this object", @@ -103598,9 +105326,9 @@ "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the Zone name of the Pod", + "name": "zonename", + "type": "string" }, { "description": "the allocation state of the Pod", @@ -103608,9 +105336,14 @@ "type": "string" }, { - "description": "the ID of the Pod", - "name": "id", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the ending IP for the Pod. This parameter is deprecated, please use 'endip' from ipranges parameter.", + "name": "endip", + "type": "list" }, { "description": "the Zone ID of the Pod", @@ -103618,119 +105351,145 @@ "type": "string" }, { - "description": "the name of the Pod", - "name": "name", - "type": "string" + "description": "the starting IP for the Pod. This parameter is deprecated, please use 'startip' from ipranges parameter.", + "name": "startip", + "type": "list" }, { "description": "the gateway of the Pod", "name": "gateway", "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": "indicates Vlan ID for the range. This parameter is deprecated, please use 'vlanid' from ipranges parameter.", - "name": "vlanid", - "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 ending IP for the Pod. This parameter is deprecated, please use 'endip' from ipranges parameter.", - "name": "endip", - "type": "list" - }, { "description": "the capacity of the Pod", "name": "capacity", "response": [ - { - "description": "the capacity type", - "name": "type", - "type": "short" - }, { "description": "the Zone ID", "name": "zoneid", "type": "string" }, + { + "description": "the Pod name", + "name": "podname", + "type": "string" + }, + { + "description": "the total capacity available", + "name": "capacitytotal", + "type": "long" + }, { "description": "the capacity currently in allocated", "name": "capacityallocated", "type": "long" }, { - "description": "the Zone name", - "name": "zonename", + "description": "the capacity currently in use", + "name": "capacityused", + "type": "long" + }, + { + "description": "the capacity name", + "name": "name", "type": "string" }, { - "description": "the Pod name", - "name": "podname", + "description": "the Pod ID", + "name": "podid", "type": "string" }, { - "description": "the capacity currently in use", - "name": "capacityused", - "type": "long" + "description": "the Cluster name", + "name": "clustername", + "type": "string" }, { - "description": "the total capacity available", - "name": "capacitytotal", - "type": "long" + "description": "the capacity type", + "name": "type", + "type": "short" + }, + { + "description": "the Cluster ID", + "name": "clusterid", + "type": "string" + }, + { + "description": "the Zone name", + "name": "zonename", + "type": "string" + }, + { + "description": "the percentage of capacity currently in use", + "name": "percentused", + "type": "string" + } + ], + "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", + "type": "string" + }, + { + "description": "the netmask of the Pod", + "name": "netmask", + "type": "string" + }, + {}, + { + "description": "indicates Vlan ID for the range. This parameter is deprecated, please use 'vlanid' from ipranges parameter.", + "name": "vlanid", + "type": "list" + }, + { + "description": "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 IP ranges for the Pod", + "name": "ipranges", + "response": [ + { + "description": "the ending IP for the range", + "name": "endip", + "type": "string" }, { - "description": "the Pod ID", - "name": "podid", + "description": "the gateway for the range", + "name": "gateway", "type": "string" }, { - "description": "the capacity name", - "name": "name", + "description": "the CIDR for the range", + "name": "cidr", "type": "string" }, { - "description": "the Cluster ID", - "name": "clusterid", + "description": "indicates Vlan ID for the range", + "name": "vlanid", "type": "string" }, { - "description": "the percentage of capacity currently in use", - "name": "percentused", + "description": "the starting IP for the range", + "name": "startip", "type": "string" }, { - "description": "the Cluster name", - "name": "clustername", + "description": "indicates if range is dedicated for CPVM and SSVM", + "name": "forsystemvms", "type": "string" } ], "type": "list" - }, - { - "description": "the starting IP for the Pod. This parameter is deprecated, please use 'startip' from ipranges parameter.", - "name": "startip", - "type": "list" - }, - { - "description": "the Zone name of the Pod", - "name": "zonename", - "type": "string" - }, - {} + } ] }, { @@ -103738,6 +105497,13 @@ "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, + "type": "string" + }, { "description": "The ID of the network ACL rule that is being moved to a new position.", "length": 255, @@ -103745,6 +105511,13 @@ "required": true, "type": "string" }, + { + "description": "The ID of the first rule that is right before the new position where the rule being moved is going to be placed. This value can be 'NULL' if the rule is being moved to the first position of the network ACL list.", + "length": 255, + "name": "previousaclruleid", + "required": false, + "type": "string" + }, { "description": "Md5 hash used to check the consistency of the ACL rule list before applying the ACL rule move. This check is useful to manage concurrency problems that may happen when multiple users are editing the same ACL rule listing. The parameter is not required. Therefore, if the user does not send it, they assume the risk of moving ACL rules without checking the consistency of the access control list before executing the move. We use MD5 hash function on a String that is composed of all UUIDs of the ACL rules in concatenated in their respective order (order defined via 'number' field).", "length": 255, @@ -103759,37 +105532,58 @@ "required": false, "since": "4.4", "type": "string" + } + ], + "related": "", + "response": [ + { + "description": "the traffic type for the ACL", + "name": "traffictype", + "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": "type of the icmp message being sent", + "name": "icmptype", + "type": "integer" + }, + { + "description": "the protocol of the ACL", + "name": "protocol", "type": "string" }, { - "description": "The ID of the rule that is right after the new position where the rule being moved is going to be placed. This value can be 'NULL' if the rule is being moved to the last position of the network ACL list.", - "length": 255, - "name": "nextaclruleid", - "required": false, + "description": "is rule for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, + { + "description": "the state of the rule", + "name": "state", "type": "string" - } - ], - "related": "", - "response": [ + }, + { + "description": "error code for this icmp message", + "name": "icmpcode", + "type": "integer" + }, { "description": "an explanation on why this ACL rule is being applied", "name": "reason", "type": "string" }, { - "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the ID of the ACL Item", - "name": "id", + "description": "the name of the ACL this item belongs to", + "name": "aclname", + "type": "string" + }, + { + "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", "type": "string" }, { @@ -103797,30 +105591,43 @@ "name": "number", "type": "integer" }, - {}, - {}, + { + "description": "Action of ACL Item. Allow/Deny", + "name": "action", + "type": "string" + }, + { + "description": "the ID of the ACL Item", + "name": "id", + "type": "string" + }, { "description": "the list of resource tags associated with the network ACLs", "name": "tags", "response": [ + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, { "description": "the project name where tag belongs to", "name": "project", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { @@ -103834,32 +105641,28 @@ "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the 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 account associated with the tag", + "name": "account", "type": "string" } ], "type": "list" }, + {}, { - "description": "is rule for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "the ending port of ACL's port range", + "name": "endport", + "type": "string" }, { "description": "the ID of the ACL this item belongs to", @@ -103867,59 +105670,15 @@ "type": "string" }, { - "description": "the protocol of the ACL", - "name": "protocol", - "type": "string" - }, - { - "description": "the name of the ACL this item belongs to", - "name": "aclname", - "type": "string" - }, - { - "description": "the traffic type for the ACL", - "name": "traffictype", - "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": "error code for this icmp message", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "type of the icmp message being sent", - "name": "icmptype", - "type": "integer" - }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - }, - { - "description": "the state of the rule", - "name": "state", - "type": "string" - }, - { - "description": "the starting port of ACL's port range", - "name": "startport", - "type": "string" - }, - { - "description": "the ending port of ACL's port range", - "name": "endport", - "type": "string" - }, - { - "description": "Action of ACL Item. Allow/Deny", - "name": "action", - "type": "string" } ] }, @@ -103936,14 +105695,6 @@ "required": true, "type": "uuid" }, - { - "description": "the ID of the virtual machine", - "length": 255, - "name": "virtualmachineid", - "related": "attachIso,destroyVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,startVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines", - "required": true, - "type": "uuid" - }, { "description": "If true, ejects existing ISO before attaching on VMware. Default: false", "length": 255, @@ -103951,329 +105702,184 @@ "required": false, "since": "4.15.1", "type": "boolean" + }, + { + "description": "the ID of the virtual machine", + "length": 255, + "name": "virtualmachineid", + "related": "attachIso,destroyVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,startVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines", + "required": true, + "type": "uuid" } ], "related": "destroyVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,startVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines", "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": "the write (io) of disk on the vm", - "name": "diskiowrite", + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", "type": "long" }, { - "description": "the read (bytes) of disk on the vm", - "name": "diskkbsread", - "type": "long" + "description": "State of the Service from LB rule", + "name": "servicestate", + "type": "string" }, { - "description": "the list of resource tags associated", - "name": "tags", + "description": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", "response": [ { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the account owning the affinity group", + "name": "account", "type": "string" }, { - "description": "tag key name", - "name": "key", - "type": "string" + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the domain ID of the affinity group", + "name": "domainid", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the name of the affinity group", + "name": "name", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the project name of the affinity group", + "name": "project", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the type of the affinity group", + "name": "type", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the project ID of the affinity group", + "name": "projectid", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the domain name of the affinity group", + "name": "domain", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the ID of the affinity group", + "name": "id", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the description of the affinity group", + "name": "description", "type": "string" } ], "type": "set" }, { - "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 the host for the virtual machine", - "name": "hostname", - "type": "string" + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", - "type": "string" + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" }, { - "description": "device type of the root volume", - "name": "rootdevicetype", + "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", + "description": "the state of the virtual machine", + "name": "state", "type": "string" }, { - "description": "the read (io) of disk on the vm", - "name": "diskioread", - "type": "long" - }, - { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", + "description": "the group ID of the virtual machine", + "name": "groupid", "type": "string" }, + {}, { - "description": "the ID of the disk offering of the virtual machine", - "name": "diskofferingid", + "description": "the ID of the availablility zone for the virtual machine", + "name": "zoneid", "type": "string" }, { - "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": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" }, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", + "description": "the group name of the virtual machine", + "name": "group", "type": "string" }, { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", + "description": "the name of the host for the virtual machine", + "name": "hostname", "type": "string" }, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", "type": "string" }, { - "description": "OS type id of the vm", - "name": "ostypeid", + "description": "the pool type of the virtual machine", + "name": "pooltype", "type": "string" }, { - "description": "the ID of the availablility zone for the virtual machine", - "name": "zoneid", + "description": "ssh key-pairs", + "name": "keypairs", "type": "string" }, { - "description": "the password (if exists) of the virtual machine", - "name": "password", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "description": "list of security groups associated with the virtual machine", - "name": "securitygroup", - "response": [ - { - "description": "the 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 project name of the group", - "name": "project", - "type": "string" - }, - { - "description": "the description of the security group", - "name": "description", - "type": "string" - }, - { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" - }, - { - "description": "the domain ID of the security group", - "name": "domainid", - "type": "string" - }, - { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" - }, - { - "description": "the list of egress rules associated with the security group", - "name": "egressrule", - "response": [ - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the 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": "account owning the security group rule", - "name": "account", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the ID of the security group", - "name": "id", - "type": "string" - }, + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", + "type": "string" + }, + { + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", + "type": "string" + }, + { + "description": "list of security groups associated with the virtual machine", + "name": "securitygroup", + "response": [ { - "description": "the list of ingress rules associated with the security group", - "name": "ingressrule", + "description": "the list of egress rules associated with the security group", + "name": "egressrule", "response": [ + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, { "description": "account owning the security group rule", "name": "account", @@ -104284,8 +105890,8 @@ "name": "tags", "response": [ { - "description": "resource type", - "name": "resourcetype", + "description": "tag key name", + "name": "key", "type": "string" }, { @@ -104299,33 +105905,33 @@ "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { @@ -104336,19 +105942,14 @@ ], "type": "set" }, - { - "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", + "description": "the type of the ICMP message response", + "name": "icmptype", "type": "integer" }, { @@ -104357,8 +105958,13 @@ "type": "string" }, { - "description": "the starting IP of the security group rule", - "name": "startport", + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", "type": "integer" }, { @@ -104367,18 +105973,23 @@ "type": "string" }, { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", + "description": "the starting IP of the security group rule", + "name": "startport", "type": "integer" } ], "type": "set" }, + { + "description": "the description of the security group", + "name": "description", + "type": "string" + }, + { + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" + }, { "description": "the name of the security group", "name": "name", @@ -104389,8 +106000,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", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", "type": "string" }, { @@ -104404,111 +106030,230 @@ "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": "tag key name", - "name": "key", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { "description": "the ID of the domain associated with the tag", "name": "domainid", "type": "string" + } + ], + "type": "set" + }, + { + "description": "the domain ID of the security group", + "name": "domainid", + "type": "string" + }, + { + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" + }, + { + "description": "the account owning the security group", + "name": "account", + "type": "string" + }, + { + "description": "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 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 account associated with the tag", + "description": "account owning the security group rule", "name": "account", "type": "string" }, { - "description": "tag value", - "name": "value", + "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 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 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": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the id of the security group rule", + "name": "ruleid", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", "type": "string" + }, + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" } ], "type": "set" + }, + { + "description": "the ID of the security group", + "name": "id", + "type": "string" + }, + { + "description": "the domain name of the security group", + "name": "domain", + "type": "string" } ], "type": "set" }, { - "description": "the group ID of the virtual machine", - "name": "groupid", + "description": "the ID of the virtual machine", + "name": "id", "type": "string" }, { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" - }, - { - "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 ID of the domain in which the virtual machine exists", - "name": "domainid", + "description": "the ID of the disk offering of the virtual machine", + "name": "diskofferingid", "type": "string" }, { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", "type": "string" }, { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" - }, - { - "description": "the number of cpu this virtual machine is running with", - "name": "cpunumber", - "type": "integer" + "description": "device type of the root volume", + "name": "rootdevicetype", + "type": "string" }, { - "description": "State of the Service from LB rule", - "name": "servicestate", + "description": "the account associated with the virtual machine", + "name": "account", "type": "string" }, { - "description": "the group name of the virtual machine", - "name": "group", + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", "type": "string" }, + {}, { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", - "type": "boolean" + "description": "OS name of the vm", + "name": "osdisplayname", + "type": "string" }, { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", + "description": "the ID of the host for the virtual machine", + "name": "hostid", "type": "string" }, - {}, { - "description": "ssh key-pair", - "name": "keypair", + "description": "Guest vm Boot Type", + "name": "boottype", "type": "string" }, { - "description": "the vgpu type used by the virtual machine", - "name": "vgpu", - "type": "string" + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" }, { "description": "the total number of network traffic bytes sent", @@ -104516,84 +106261,176 @@ "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": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", + "type": "string" }, {}, + { + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", + "type": "string" + }, { "description": "public IP address id associated with vm via Static nat rule", "name": "publicip", "type": "string" }, { - "description": "the incoming network traffic on the vm", - "name": "networkkbsread", - "type": "long" + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" }, { - "description": "the list of nics associated with vm", - "name": "nic", + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" + }, + { + "description": "the list of resource tags associated", + "name": "tags", "response": [ { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" + "description": "the account associated with the tag", + "name": "account", + "type": "string" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the type of the nic", - "name": "type", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the ID of the nic", - "name": "id", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", + "description": "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": "the name of the corresponding network", - "name": "networkname", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "tag value", + "name": "value", "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": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "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": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "the name of the disk offering of the virtual machine", + "name": "diskofferingname", + "type": "string" + }, + { + "description": "Guest vm Boot Mode", + "name": "bootmode", + "type": "string" + }, + { + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", + "type": "string" + }, + { + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" + }, + { + "description": "the name of the virtual machine", + "name": "name", + "type": "string" + }, + { + "description": "the read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" + }, + { + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" + }, + { + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", + "type": "boolean" + }, + { + "description": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" + }, + { + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" + }, + { + "description": "the list of nics associated with vm", + "name": "nic", + "response": [ { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", + "type": "string" }, { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" + "description": "the ID of the nic", + "name": "id", + "type": "string" }, { "description": "the isolated private VLAN type if available", @@ -104601,28 +106438,23 @@ "type": "string" }, { - "description": "the IPv6 address of network", - "name": "ip6address", - "type": "string" - }, - { - "description": "the ID of the corresponding network", - "name": "networkid", + "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 isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" }, { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "description": "true if nic is default, false otherwise", + "name": "macaddress", "type": "string" }, { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", "type": "string" }, { @@ -104630,24 +106462,24 @@ "name": "isdefault", "type": "boolean" }, - { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", - "type": "string" - }, { "description": "the gateway of IPv6 network", "name": "ip6gateway", "type": "string" }, { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "the isolation uri of the nic", + "name": "isolationuri", "type": "string" }, { - "description": "the netmask of the nic", - "name": "netmask", + "description": "the ID of the corresponding network", + "name": "networkid", "type": "string" }, { @@ -104656,254 +106488,191 @@ "type": "string" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "the name of the corresponding network", + "name": "networkname", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", "type": "string" - } - ], - "type": "set" - }, - { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" - }, - { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", - "type": "string" - }, - { - "description": "the project id of the vm", - "name": "projectid", - "type": "string" - }, - { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", - "type": "string" - }, - { - "description": "the user's name who deployed the virtual machine", - "name": "username", - "type": "string" - }, - { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", - "type": "string" - }, - { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", - "type": "string" - }, - { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", - "type": "string" - }, - { - "description": "the name of the virtual machine", - "name": "name", - "type": "string" - }, - { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", - "type": "string" - }, - { - "description": "the ID of the virtual machine", - "name": "id", - "type": "string" - }, - { - "description": "the speed of each cpu", - "name": "cpuspeed", - "type": "integer" - }, - { - "description": "the project name of the vm", - "name": "project", - "type": "string" - }, - { - "description": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", - "response": [ + }, { - "description": "the 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 project ID of the affinity group", - "name": "projectid", + "description": "the IPv6 address of network", + "name": "ip6address", "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 name of the affinity group", - "name": "project", + "description": "the traffic type of the nic", + "name": "traffictype", "type": "string" }, { - "description": "the domain ID of the affinity group", - "name": "domainid", + "description": "the gateway of the nic", + "name": "gateway", "type": "string" }, { - "description": "the type of the affinity group", + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" + }, + { + "description": "the type of the nic", "name": "type", "type": "string" }, { - "description": "the ID of the affinity group", - "name": "id", + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "the description of the affinity group", - "name": "description", + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "the netmask of the nic", + "name": "netmask", "type": "string" }, { - "description": "the domain name of the affinity group", - "name": "domain", + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", "type": "string" }, { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", "type": "list" } ], "type": "set" }, { - "description": "the write (bytes) of disk on the vm", - "name": "diskkbswrite", - "type": "long" + "description": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" }, { - "description": "the state of the virtual machine", - "name": "state", + "description": "the project name of the vm", + "name": "project", "type": "string" }, { - "description": "the account associated with the virtual machine", - "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 ISO attached to the virtual machine", - "name": "isoid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" + }, + { + "description": "the user's ID who deployed the virtual machine", + "name": "userid", "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 hypervisor on which the template runs", - "name": "hypervisor", + "description": "the password (if exists) of the virtual machine", + "name": "password", "type": "string" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "the memory used by the vm", - "name": "memorykbs", - "type": "long" - }, - { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", + "type": "string" }, { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", "type": "string" }, { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" + "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", + "type": "long" }, { - "description": "the 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": "OS name of the vm", - "name": "osdisplayname", - "type": "string" + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" }, - {}, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", - "type": "string" + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" }, { - "description": "Guest vm Boot Type", - "name": "boottype", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { - "description": "the internal memory that's free in vm or zero if it can not be calculated", - "name": "memoryintfreekbs", - "type": "long" + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", + "type": "string" }, { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", "type": "boolean" }, { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", + "description": "the project id of the vm", + "name": "projectid", "type": "string" }, { - "description": "the pool type of the virtual machine", - "name": "pooltype", + "description": "OS type id of the vm", + "name": "ostypeid", "type": "string" }, { - "description": "the outgoing network traffic on the host", - "name": "networkkbswrite", - "type": "long" - }, - { - "description": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" }, { - "description": "the target memory in vm", - "name": "memorytargetkbs", + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", "type": "long" } ] @@ -104934,16 +106703,16 @@ "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" } ] }, @@ -104952,20 +106721,6 @@ "isasync": false, "name": "listBaremetalDhcp", "params": [ - { - "description": "Type of DHCP device", - "length": 255, - "name": "dhcpservertype", - "required": false, - "type": "string" - }, - { - "description": "DHCP server device ID", - "length": 255, - "name": "id", - "required": false, - "type": "long" - }, { "description": "", "length": 255, @@ -104973,6 +106728,14 @@ "required": false, "type": "integer" }, + { + "description": "the Physical Network ID", + "length": 255, + "name": "physicalnetworkid", + "related": "", + "required": true, + "type": "uuid" + }, { "description": "", "length": 255, @@ -104981,12 +106744,11 @@ "type": "integer" }, { - "description": "the Physical Network ID", + "description": "Type of DHCP device", "length": 255, - "name": "physicalnetworkid", - "related": "", - "required": true, - "type": "uuid" + "name": "dhcpservertype", + "required": false, + "type": "string" }, { "description": "List by keyword", @@ -104994,13 +106756,20 @@ "name": "keyword", "required": false, "type": "string" + }, + { + "description": "DHCP server device ID", + "length": 255, + "name": "id", + "required": false, + "type": "long" } ], "related": "", "response": [ { - "description": "name of the provider", - "name": "dhcpservertype", + "description": "url", + "name": "url", "type": "string" }, { @@ -105008,32 +106777,32 @@ "name": "physicalnetworkid", "type": "string" }, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "url", - "name": "url", + "description": "name of the provider", + "name": "dhcpservertype", "type": "string" }, {}, + { + "description": "device id of ", + "name": "id", + "type": "string" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + {}, { "description": "name of the provider", "name": "provider", "type": "string" - }, - { - "description": "device id of ", - "name": "id", - "type": "string" } ] }, @@ -105054,45 +106823,40 @@ "related": "cancelStorageMaintenance", "response": [ { - "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 storage pool path", - "name": "path", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the storage pool capabilities", - "name": "storagecapabilities", - "type": "map" + "description": "the Pod name of the storage pool", + "name": "podname", + "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "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 date and time the storage pool was created", + "name": "created", + "type": "date" }, { - "description": "the ID of the storage pool", - "name": "id", + "description": "the tags for the storage pool", + "name": "tags", "type": "string" }, { - "description": "true if this pool is suitable to migrate a volume, false otherwise", - "name": "suitableformigration", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, - { - "description": "Storage provider for this pool", - "name": "provider", - "type": "string" - }, { "description": "the hypervisor type of the storage pool", "name": "hypervisor", @@ -105104,96 +106868,101 @@ "type": "string" }, { - "description": "IOPS CloudStack can provision from this storage pool", - "name": "capacityiops", - "type": "long" + "description": "the overprovisionfactor for the storage pool", + "name": "overprovisionfactor", + "type": "string" }, - {}, { - "description": "the Zone name of the storage pool", - "name": "zonename", + "description": "the storage pool type", + "name": "type", "type": "string" }, { - "description": "the tags for the storage pool", - "name": "tags", + "description": "the ID of the cluster for the storage pool", + "name": "clusterid", "type": "string" }, { - "description": "the host's currently used disk size", - "name": "disksizeused", + "description": "total min IOPS currently in use by volumes", + "name": "allocatediops", "type": "long" }, { - "description": "the storage pool type", - "name": "type", - "type": "string" + "description": "IOPS CloudStack can provision from this storage pool", + "name": "capacityiops", + "type": "long" }, { - "description": "the Zone ID of the storage pool", - "name": "zoneid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the name of the cluster for the storage pool", - "name": "clustername", - "type": "string" + "description": "the host's currently allocated disk size", + "name": "disksizeallocated", + "type": "long" }, - {}, { - "description": "the Pod name of the storage pool", - "name": "podname", + "description": "the ID of the storage pool", + "name": "id", "type": "string" }, + {}, { - "description": "the scope of the storage pool", - "name": "scope", - "type": "string" + "description": "the storage pool capabilities", + "name": "storagecapabilities", + "type": "map" }, { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", - "type": "long" + "description": "the name of the cluster for the storage pool", + "name": "clustername", + "type": "string" }, { - "description": "the state of the storage pool", - "name": "state", - "type": "storagepoolstatus" + "description": "the storage pool path", + "name": "path", + "type": "string" }, { "description": "the Pod ID of the storage pool", "name": "podid", "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 UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the scope of the storage pool", + "name": "scope", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "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 overprovisionfactor for the storage pool", - "name": "overprovisionfactor", + "description": "Storage provider for this pool", + "name": "provider", "type": "string" }, { - "description": "the date and time the storage pool was created", - "name": "created", - "type": "date" + "description": "the name of the storage pool", + "name": "name", + "type": "string" + }, + { + "description": "the Zone name of the storage pool", + "name": "zonename", + "type": "string" } ] }, @@ -105204,33 +106973,27 @@ "params": [], "related": "", "response": [ - {}, { - "description": "DN password", - "name": "bindpass", + "description": "Specify the LDAP port if required, default is 389", + "name": "port", "type": "string" }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "The search base defines the starting point for the search in the directory tree Example: dc=cloud,dc=com", "name": "searchbase", "type": "string" }, { - "description": "Specify the distinguished name of a user with the search permission on the directory", - "name": "binddn", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, - {}, { "description": "Hostname or ip address of the ldap server eg: my.ldap.com", "name": "hostname", "type": "string" }, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", @@ -105241,9 +107004,15 @@ "name": "queryfilter", "type": "string" }, + {}, { - "description": "Specify the LDAP port if required, default is 389", - "name": "port", + "description": "Specify the distinguished name of a user with the search permission on the directory", + "name": "binddn", + "type": "string" + }, + { + "description": "DN password", + "name": "bindpass", "type": "string" }, { @@ -105260,16 +107029,16 @@ "name": "createUser", "params": [ { - "description": "User UUID, required for adding account from external provisioning system", + "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": "userid", - "required": false, + "name": "password", + "required": true, "type": "string" }, { - "description": "lastname", + "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": "lastname", + "name": "account", "required": true, "type": "string" }, @@ -105281,11 +107050,12 @@ "type": "string" }, { - "description": "Specifies a timezone for this command. For more information on the timezone parameter, see Time Zone Format.", + "description": "Creates the user under the specified domain. Has to be accompanied with the account parameter", "length": 255, - "name": "timezone", + "name": "domainid", + "related": "listDomains", "required": false, - "type": "string" + "type": "uuid" }, { "description": "email", @@ -105295,107 +107065,105 @@ "type": "string" }, { - "description": "firstname", + "description": "lastname", "length": 255, - "name": "firstname", + "name": "lastname", "required": true, "type": "string" }, { - "description": "Creates the user under the specified account. If no account is specified, the username will be used as the account name.", + "description": "User UUID, required for adding account from external provisioning system", "length": 255, - "name": "account", - "required": true, + "name": "userid", + "required": false, "type": "string" }, { - "description": "Creates the user under the specified domain. Has to be accompanied with the account parameter", + "description": "firstname", "length": 255, - "name": "domainid", - "related": "listDomains", - "required": false, - "type": "uuid" + "name": "firstname", + "required": true, + "type": "string" }, { - "description": "Clear text password (Default hashed to SHA256SALT). If you wish to use any other hashing algorithm, you would need to write a custom authentication adapter See Docs section.", + "description": "Specifies a timezone for this command. For more information on the timezone parameter, see Time Zone Format.", "length": 255, - "name": "password", - "required": true, + "name": "timezone", + "required": false, "type": "string" } ], "related": "getUser", "response": [ + {}, { - "description": "the boolean value representing if the updating target is in caller's child domain", - "name": "iscallerchilddomain", - "type": "boolean" + "description": "the type of the role", + "name": "roletype", + "type": "string" }, { - "description": "the name of the role", - "name": "rolename", + "description": "the user state", + "name": "state", "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 user ID", - "name": "id", - "type": "string" + "description": "the account type of the user", + "name": "accounttype", + "type": "integer" }, { - "description": "the timezone user was created in", - "name": "timezone", + "description": "the ID of the role", + "name": "roleid", "type": "string" }, { - "description": "the user name", - "name": "username", + "description": "the user ID", + "name": "id", "type": "string" }, - {}, { - "description": "the account type of the user", - "name": "accounttype", - "type": "short" + "description": "the user email address", + "name": "email", + "type": "string" }, { - "description": "the account ID of the user", - "name": "accountid", + "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" }, { - "description": "the ID of the role", - "name": "roleid", + "description": "the timezone user was created in", + "name": "timezone", "type": "string" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the boolean value representing if the updating target is in caller's child domain", + "name": "iscallerchilddomain", + "type": "boolean" }, { - "description": "the user state", - "name": "state", + "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 user name", + "name": "username", "type": "string" }, { - "description": "the source type of the user in lowercase, such as native, ldap, saml2", - "name": "usersource", + "description": "the domain ID of the user", + "name": "domainid", "type": "string" }, { @@ -105404,8 +107172,8 @@ "type": "boolean" }, { - "description": "the domain name of the user", - "name": "domain", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -105414,39 +107182,40 @@ "type": "string" }, { - "description": "the user firstname", - "name": "firstname", + "description": "the secret key of the user", + "name": "secretkey", "type": "string" }, { - "description": "the api key of the user", - "name": "apikey", - "type": "string" + "description": "the date and time the user account was created", + "name": "created", + "type": "date" }, { - "description": "the secret key of the user", - "name": "secretkey", + "description": "the domain name of the user", + "name": "domain", "type": "string" }, { - "description": "the user email address", - "name": "email", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the domain ID of the user", - "name": "domainid", + "description": "the api key of the user", + "name": "apikey", "type": "string" }, + {}, { - "description": "the account name of the user", - "name": "account", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the date and time the user account was created", - "name": "created", - "type": "date" + "description": "the account ID of the user", + "name": "accountid", + "type": "string" } ] }, @@ -105471,11 +107240,42 @@ "type": "integer" }, { - "description": "true if api is asynchronous", - "name": "isasync", - "type": "boolean" + "description": "version of CloudStack the api was introduced in", + "name": "since", + "type": "string" + }, + { + "description": "api response fields", + "name": "response", + "response": [ + { + "description": "response field type", + "name": "type", + "type": "string" + }, + { + "description": "description of the api response field", + "name": "description", + "type": "string" + }, + { + "description": "api response fields", + "name": "response", + "type": "set" + }, + { + "description": "the name of the api response field", + "name": "name", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "comma separated related apis", + "name": "related", + "type": "string" }, - {}, { "description": "the name of the api command", "name": "name", @@ -105487,34 +107287,31 @@ "type": "string" }, { - "description": "comma separated related apis", - "name": "related", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "version of CloudStack the api was introduced in", - "name": "since", + "description": "response field type", + "name": "type", "type": "string" }, + { + "description": "true if api is asynchronous", + "name": "isasync", + "type": "boolean" + }, + {}, + {}, { "description": "the list params the api accepts", "name": "params", "response": [ - { - "description": "true if this parameter is required for the api request", - "name": "required", - "type": "boolean" - }, { "description": "comma separated related apis to get the parameter", "name": "related", "type": "string" }, - { - "description": "length of the parameter", - "name": "length", - "type": "int" - }, { "description": "description of the api parameter", "name": "description", @@ -105525,56 +107322,28 @@ "name": "type", "type": "string" }, - { - "description": "version of CloudStack the api was introduced in", - "name": "since", - "type": "string" - }, { "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": "response field type", - "name": "type", - "type": "string" }, { - "description": "api response fields", - "name": "response", - "type": "set" + "description": "true if this parameter is required for the api request", + "name": "required", + "type": "boolean" }, { - "description": "description of the api response field", - "name": "description", + "description": "version of CloudStack the api was introduced in", + "name": "since", "type": "string" }, { - "description": "the name of the api response field", - "name": "name", - "type": "string" + "description": "length of the parameter", + "name": "length", + "type": "int" } ], "type": "set" - }, - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" } ], "since": "4.1.0" @@ -105604,17 +107373,17 @@ "name": "jobid", "type": "string" }, - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - }, {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + }, {} ] }, @@ -105623,14 +107392,6 @@ "isasync": true, "name": "createVpnGateway", "params": [ - { - "description": "public ip address id of the vpn gateway", - "length": 255, - "name": "vpcid", - "related": "createVPC,listVPCs,updateVPC", - "required": true, - "type": "uuid" - }, { "description": "an optional field, whether to the display the vpn to the end user or not", "length": 255, @@ -105638,33 +107399,46 @@ "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": "is vpn gateway for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "the project name", + "name": "project", + "type": "string" }, { - "description": "the domain name of the owner", - "name": "domain", + "description": "the owner", + "name": "account", "type": "string" }, { - "description": "the project name", - "name": "project", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the vpc name of this gateway", - "name": "vpcname", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the domain id of the owner", + "name": "domainid", "type": "string" }, { - "description": "the vpn gateway ID", - "name": "id", + "description": "the domain name of the owner", + "name": "domain", "type": "string" }, { @@ -105673,40 +107447,35 @@ "type": "date" }, { - "description": "the project id", - "name": "projectid", + "description": "the public IP address", + "name": "publicip", "type": "string" }, - {}, { "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 public IP address", - "name": "publicip", + "description": "the vpn gateway ID", + "name": "id", "type": "string" }, {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the vpc name of this gateway", + "name": "vpcname", "type": "string" }, { - "description": "the domain id of the owner", - "name": "domainid", - "type": "string" + "description": "is vpn gateway for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, { - "description": "the owner", - "name": "account", + "description": "the project id", + "name": "projectid", "type": "string" } ] @@ -105717,26 +107486,25 @@ "name": "createVMSnapshot", "params": [ { - "description": "quiesce vm if true", + "description": "snapshot memory if true", "length": 255, - "name": "quiescevm", + "name": "snapshotmemory", "required": false, "type": "boolean" }, { - "description": "snapshot memory if true", + "description": "The description of the snapshot", "length": 255, - "name": "snapshotmemory", + "name": "description", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "The ID of the vm", + "description": "quiesce vm if true", "length": 255, - "name": "virtualmachineid", - "related": "destroyVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,startVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines", - "required": true, - "type": "uuid" + "name": "quiescevm", + "required": false, + "type": "boolean" }, { "description": "The display name of the snapshot", @@ -105746,19 +107514,80 @@ "type": "string" }, { - "description": "The description of the snapshot", + "description": "The ID of the vm", "length": 255, - "name": "description", - "required": false, - "type": "string" + "name": "virtualmachineid", + "related": "destroyVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,startVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines", + "required": true, + "type": "uuid" } ], "related": "", "response": [ + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the name of the vm snapshot", + "name": "name", + "type": "string" + }, + { + "description": "the state of the vm snapshot", + "name": "state", + "type": "state" + }, + { + "description": "the type of hypervisor on which snapshot is stored", + "name": "hypervisor", + "type": "hypervisortype" + }, + { + "description": "the vm ID of the vm snapshot", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "the account associated with the disk volume", + "name": "account", + "type": "string" + }, {}, { - "description": "the ID of the domain associated with the disk volume", - "name": "domainid", + "description": "the Zone name of the vm snapshot", + "name": "zonename", + "type": "string" + }, + { + "description": "the Zone ID of the vm snapshot", + "name": "zoneid", + "type": "string" + }, + { + "description": "the display name of the vm snapshot", + "name": "displayname", + "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the project id of the vpn", + "name": "projectid", + "type": "string" + }, + { + "description": "the domain associated with the disk volume", + "name": "domain", "type": "string" }, { @@ -105766,8 +107595,8 @@ "name": "tags", "response": [ { - "description": "tag key name", - "name": "key", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { @@ -105776,8 +107605,8 @@ "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { @@ -105785,6 +107614,11 @@ "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", @@ -105795,88 +107629,49 @@ "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", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "tag key name", + "name": "key", "type": "string" } ], "type": "set" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "indiates if this is current snapshot", + "name": "current", "type": "boolean" }, { - "description": "the account associated with the disk volume", - "name": "account", + "description": "the description of the vm snapshot", + "name": "description", "type": "string" }, + {}, { "description": "the parent ID of the vm snapshot", "name": "parent", "type": "string" }, { - "description": "the domain associated with the disk volume", - "name": "domain", - "type": "string" - }, - { - "description": "the ID of the vm snapshot", - "name": "id", - "type": "string" - }, - { - "description": "VM Snapshot type", - "name": "type", - "type": "string" - }, - { - "description": "the parent displayName of the vm snapshot", - "name": "parentName", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the display name of the vm snapshot", - "name": "displayname", - "type": "string" - }, - { - "description": "the Zone name of the vm snapshot", - "name": "zonename", - "type": "string" - }, - { - "description": "the vm ID of the vm snapshot", - "name": "virtualmachineid", + "description": "the ID of the domain associated with the disk volume", + "name": "domainid", "type": "string" }, { - "description": "the project id of the vpn", - "name": "projectid", - "type": "string" + "description": "the create date of the vm snapshot", + "name": "created", + "type": "date" }, { "description": "the vm name of the vm snapshot", @@ -105884,50 +107679,24 @@ "type": "string" }, { - "description": "the type of hypervisor on which snapshot is stored", - "name": "hypervisor", - "type": "hypervisortype" - }, - { - "description": "the project name of the vpn", - "name": "project", - "type": "string" - }, - {}, - { - "description": "the name of the vm snapshot", - "name": "name", - "type": "string" - }, - { - "description": "indiates if this is current snapshot", - "name": "current", - "type": "boolean" - }, - { - "description": "the Zone ID of the vm snapshot", - "name": "zoneid", - "type": "string" - }, - { - "description": "the description of the vm snapshot", - "name": "description", + "description": "the parent displayName of the vm snapshot", + "name": "parentName", "type": "string" }, { - "description": "the create date of the vm snapshot", - "name": "created", - "type": "date" + "description": "the ID of the vm snapshot", + "name": "id", + "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "VM Snapshot type", + "name": "type", + "type": "string" }, { - "description": "the state of the vm snapshot", - "name": "state", - "type": "state" + "description": "the project name of the vpn", + "name": "project", + "type": "string" } ], "since": "4.2.0" @@ -105937,6 +107706,13 @@ "isasync": true, "name": "addResourceDetail", "params": [ + { + "description": "type of the resource", + "length": 255, + "name": "resourcetype", + "required": true, + "type": "string" + }, { "description": "pass false if you want this detail to be disabled for the regular user. True by default", "length": 255, @@ -105945,13 +107721,6 @@ "since": "4.4", "type": "boolean" }, - { - "description": "type of the resource", - "length": 255, - "name": "resourcetype", - "required": true, - "type": "string" - }, { "description": "Map of (key/value pairs)", "length": 255, @@ -105968,23 +107737,23 @@ } ], "response": [ + {}, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, - {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "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", @@ -105998,18 +107767,19 @@ "name": "listVpnUsers", "params": [ { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "listall", + "name": "projectid", + "related": "activateProject", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "", + "description": "the username of the vpn user.", "length": 255, - "name": "pagesize", + "name": "username", "required": false, - "type": "integer" + "type": "string" }, { "description": "list resources by account. Must be used with the domainId parameter.", @@ -106019,63 +107789,68 @@ "type": "string" }, { - "description": "List by keyword", + "description": "The uuid of the Vpn user", "length": 255, - "name": "keyword", + "name": "id", + "related": "addVpnUser,listVpnUsers", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "the username of the vpn user.", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "username", + "name": "domainid", + "related": "listDomains", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "List by keyword", "length": 255, - "name": "isrecursive", + "name": "keyword", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "list objects by project", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "projectid", - "related": "activateProject", + "name": "isrecursive", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "The uuid of the Vpn user", + "description": "", "length": 255, - "name": "id", - "related": "addVpnUser,listVpnUsers", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "list only resources belonging to the domain specified", + "description": "", "length": 255, - "name": "domainid", - "related": "listDomains", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller 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" } ], "related": "addVpnUser", "response": [ + {}, { - "description": "the account of the remote access vpn", - "name": "account", + "description": "the project id of the vpn", + "name": "projectid", + "type": "string" + }, + { + "description": "the vpn userID", + "name": "id", "type": "string" }, { @@ -106083,47 +107858,41 @@ "name": "domain", "type": "string" }, - {}, { - "description": "the domain id of the account of the remote access vpn", - "name": "domainid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the vpn userID", - "name": "id", + "description": "the username of the vpn user", + "name": "username", "type": "string" }, { - "description": "the project id of the vpn", - "name": "projectid", + "description": "the domain id of the account of the remote access vpn", + "name": "domainid", "type": "string" }, { - "description": "the username of the vpn user", - "name": "username", + "description": "the state of the Vpn User", + "name": "state", "type": "string" }, + {}, { - "description": "the project name of the vpn", - "name": "project", + "description": "the account of the remote access vpn", + "name": "account", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the project name of the vpn", + "name": "project", "type": "string" }, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - }, - { - "description": "the state of the Vpn User", - "name": "state", - "type": "string" } ] }, @@ -106142,10 +107911,11 @@ } ], "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" }, {}, { @@ -106153,16 +107923,15 @@ "name": "success", "type": "boolean" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" } ], "since": "4.2.0" @@ -106183,14 +107952,19 @@ ], "response": [ { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, + { + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, { @@ -106198,12 +107972,7 @@ "name": "jobstatus", "type": "integer" }, - {}, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - } + {} ] }, { @@ -106211,13 +107980,6 @@ "isasync": false, "name": "addRegion", "params": [ - { - "description": "Region service endpoint", - "length": 255, - "name": "endpoint", - "required": true, - "type": "string" - }, { "description": "Name of the region", "length": 255, @@ -106231,47 +107993,54 @@ "name": "id", "required": true, "type": "integer" + }, + { + "description": "Region service endpoint", + "length": 255, + "name": "endpoint", + "required": true, + "type": "string" } ], "related": "", "response": [ { - "description": "true if GSLB service is enabled in the region, false otherwise", - "name": "gslbserviceenabled", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "true if security groups support is enabled, false otherwise", - "name": "portableipserviceenabled", - "type": "boolean" + "description": "the end point of the region", + "name": "endpoint", + "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "true if GSLB service is enabled in the region, false otherwise", + "name": "gslbserviceenabled", + "type": "boolean" }, { "description": "the name of the region", "name": "name", "type": "string" }, - {}, - {}, { - "description": "the end point of the region", - "name": "endpoint", - "type": "string" + "description": "the ID of the region", + "name": "id", + "type": "integer" + }, + { + "description": "true if security groups support is enabled, false otherwise", + "name": "portableipserviceenabled", + "type": "boolean" }, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - { - "description": "the ID of the region", - "name": "id", - "type": "integer" - } + {} ] }, { @@ -106286,13 +108055,6 @@ "required": true, "type": "date" }, - { - "description": "End date range for usage record query. Use yyyy-MM-dd as the date format, e.g. startDate=2009-06-03.", - "length": 255, - "name": "enddate", - "required": true, - "type": "date" - }, { "description": "List events for the specified domain.", "length": 255, @@ -106300,31 +108062,38 @@ "related": "listDomains", "required": false, "type": "uuid" + }, + { + "description": "End date range for usage record query. Use yyyy-MM-dd as the date format, e.g. startDate=2009-06-03.", + "length": 255, + "name": "enddate", + "required": true, + "type": "date" } ], "response": [ + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + }, {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - }, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - } + {} ] }, { @@ -106340,15 +108109,6 @@ "required": false, "type": "list" }, - { - "description": "Role permission rule id", - "length": 255, - "name": "ruleid", - "related": "", - "required": false, - "since": "4.11", - "type": "uuid" - }, { "description": "Rule permission, can be: allow or deny", "length": 255, @@ -106364,16 +108124,30 @@ "related": "", "required": true, "type": "uuid" + }, + { + "description": "Role permission rule id", + "length": 255, + "name": "ruleid", + "related": "", + "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" + }, + {}, { "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", @@ -106383,11 +108157,6 @@ "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" @@ -106398,38 +108167,30 @@ "name": "listSSHKeyPairs", "params": [ { - "description": "list objects by project", + "description": "", "length": 255, - "name": "projectid", - "related": "activateProject", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "A public key fingerprint to look for", "length": 255, - "name": "account", + "name": "fingerprint", "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", - "length": 255, - "name": "listall", - "required": false, - "type": "boolean" - }, - { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "", "length": 255, - "name": "isrecursive", + "name": "pagesize", "required": false, - "type": "boolean" + "type": "integer" }, { - "description": "List by keyword", + "description": "A key pair name to look for", "length": 255, - "name": "keyword", + "name": "name", "required": false, "type": "string" }, @@ -106442,25 +108203,33 @@ "type": "uuid" }, { - "description": "A key pair name to look for", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "name", + "name": "account", "required": false, "type": "string" }, { - "description": "", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "pagesize", + "name": "isrecursive", "required": false, - "type": "integer" + "type": "boolean" }, { - "description": "", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "page", + "name": "projectid", + "related": "activateProject", "required": false, - "type": "integer" + "type": "uuid" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" }, { "description": "the ID of the ssh keypair", @@ -106471,32 +108240,52 @@ "type": "uuid" }, { - "description": "A public key fingerprint to look for", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "fingerprint", + "name": "listall", "required": false, - "type": "string" + "type": "boolean" } ], "related": "", "response": [ { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "ID of the ssh keypair", + "name": "id", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the owner of the keypair", + "name": "account", + "type": "string" + }, + { + "description": "Name of the keypair", + "name": "name", + "type": "string" }, - {}, {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + {}, { "description": "Fingerprint of the public key", "name": "fingerprint", "type": "string" }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, { "description": "the domain id of the keypair owner", "name": "domainid", @@ -106506,34 +108295,71 @@ "description": "the domain name of the keypair owner", "name": "domain", "type": "string" + } + ] + }, + { + "description": "Lists accounts and provides detailed account information for listed accounts", + "isasync": false, + "name": "listAccounts", + "params": [ + { + "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": "list account by account name", + "length": 255, + "name": "name", + "required": false, + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "ID of the ssh keypair", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller 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 accounts by cleanuprequired attribute (values are true or false)", + "length": 255, + "name": "iscleanuprequired", + "required": false, + "type": "boolean" + }, + { + "description": "list account by account ID", + "length": 255, "name": "id", - "type": "string" + "related": "enableAccount,listAccounts,listAccounts", + "required": false, + "type": "uuid" }, { - "description": "the owner of the keypair", - "name": "account", - "type": "string" + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" }, { - "description": "Name of the keypair", - "name": "name", - "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": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, @@ -106546,7 +108372,7 @@ "length": 255, "name": "accounttype", "required": false, - "type": "long" + "type": "integer" }, { "description": "flag to display the resource icon for accounts", @@ -106556,83 +108382,127 @@ "type": "boolean" }, { - "description": "List by keyword", + "description": "list accounts by state. Valid states are enabled, disabled, and locked.", "length": 255, - "name": "keyword", + "name": "state", + "required": false, + "type": "string" + }, + { + "description": "list only resources belonging to the domain specified", + "length": 255, + "name": "domainid", + "related": "listDomains", "required": false, + "type": "uuid" + } + ], + "related": "enableAccount,listAccounts", + "response": [ + { + "description": "the ID of the role", + "name": "roleid", + "type": "string" + }, + { + "description": "the total number of virtual machines running for this account", + "name": "vmrunning", + "type": "integer" + }, + { + "description": "the total number of public ip addresses this account can acquire", + "name": "iplimit", + "type": "string" + }, + { + "description": "the total primary storage space (in GiB) the account can own", + "name": "primarystoragelimit", + "type": "string" + }, + { + "description": "the total number of networks available to be created for this account", + "name": "networkavailable", + "type": "string" + }, + { + "description": "account type (admin, domain-admin, user)", + "name": "accounttype", + "type": "integer" + }, + { + "description": "the total memory (in MB) the account can own", + "name": "memorylimit", + "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) owned by account", + "name": "secondarystoragetotal", + "type": "float" + }, + { + "description": "the name of the account", + "name": "name", "type": "string" }, { - "description": "list accounts by cleanuprequired attribute (values are true or false)", - "length": 255, - "name": "iscleanuprequired", - "required": false, - "type": "boolean" + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" }, { - "description": "list only resources belonging to the domain specified", - "length": 255, - "name": "domainid", - "related": "listDomains", - "required": false, - "type": "uuid" + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" }, { - "description": "list account by account ID", - "length": 255, - "name": "id", - "related": "enableAccount,listAccounts,listAccounts", - "required": false, - "type": "uuid" + "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" + "description": "details for the account", + "name": "accountdetails", + "type": "map" }, { - "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": "the total number of templates which have been created by this account", + "name": "templatetotal", + "type": "long" }, { - "description": "list account by account name", - "length": 255, - "name": "name", - "required": false, + "description": "the total number of cpu cores the account can own", + "name": "cpulimit", "type": "string" }, { - "description": "list accounts by state. Valid states are enabled, disabled, and locked.", - "length": 255, - "name": "state", - "required": false, + "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, + "description": "the total number of virtual machines stopped for this account", + "name": "vmstopped", "type": "integer" }, + {}, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false", - "length": 255, - "name": "listall", - "required": false, - "type": "boolean" - } - ], - "related": "enableAccount,listAccounts", - "response": [ + "description": "the list of acl groups that account belongs to", + "name": "groups", + "type": "list" + }, { - "description": "the total number of public ip addresses available for this account to acquire", - "name": "ipavailable", + "description": "the total primary storage space (in GiB) owned by account", + "name": "primarystoragetotal", + "type": "long" + }, + { + "description": "name of the Domain the account belongs to", + "name": "domain", "type": "string" }, { @@ -106641,39 +108511,33 @@ "type": "long" }, { - "description": "the name of the role", - "name": "rolename", + "description": "the total number of snapshots available for this account", + "name": "snapshotavailable", "type": "string" }, { - "description": "the total primary storage space (in GiB) owned by account", - "name": "primarystoragetotal", - "type": "long" - }, - { - "description": "the total number of virtual machines stopped for this account", - "name": "vmstopped", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": "the total number of templates which can be created by this account", - "name": "templatelimit", + "description": "the total memory (in MB) available to be created for this account", + "name": "memoryavailable", "type": "string" }, - {}, { - "description": "the default zone of the account", - "name": "defaultzoneid", + "description": "the total number of networks the account can own", + "name": "networklimit", "type": "string" }, { - "description": "the state of the account", - "name": "state", + "description": "the total number of virtual machines that can be deployed by this account", + "name": "vmlimit", "type": "string" }, { - "description": "the name of the account", - "name": "name", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -106682,107 +108546,152 @@ "type": "string" }, { - "description": "the total number of templates available to be created by this account", - "name": "templateavailable", + "description": "path of the Domain the account belongs to", + "name": "domainpath", "type": "string" }, { - "description": "path of the Domain the account belongs to", - "name": "domainpath", + "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 cpu cores available to be created for this account", + "name": "cpuavailable", "type": "string" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", + "description": "the total number of projects the account can own", + "name": "projectlimit", + "type": "string" + }, + { + "description": "true if account is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "the total primary storage space (in GiB) available to be used for this account", + "name": "primarystorageavailable", + "type": "string" + }, + { + "description": "the total number of vpcs the account can own", + "name": "vpclimit", + "type": "string" + }, + { + "description": "the total volume being used by this account", + "name": "volumetotal", "type": "long" }, { - "description": "the total number of templates which have been created by this account", - "name": "templatetotal", + "description": "the total number of snapshots stored by this account", + "name": "snapshottotal", "type": "long" }, { - "description": "the total number of cpu cores owned by account", - "name": "cputotal", + "description": "the default zone of the account", + "name": "defaultzoneid", + "type": "string" + }, + { + "description": "the total number of virtual machines deployed by this account", + "name": "vmtotal", "type": "long" }, { - "description": "account type (admin, domain-admin, user)", - "name": "accounttype", - "type": "short" + "description": "id of the Domain the account belongs to", + "name": "domainid", + "type": "string" }, { - "description": "details for the account", - "name": "accountdetails", - "type": "map" + "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 memory (in MB) owned by account", + "name": "memorytotal", + "type": "long" + }, + { + "description": "the total number of templates which can be created by this account", + "name": "templatelimit", + "type": "string" }, { "description": "the list of users associated with account", "name": "user", "response": [ { - "description": "the user email address", - "name": "email", + "description": "the user lastname", + "name": "lastname", "type": "string" }, { - "description": "the user firstname", - "name": "firstname", + "description": "the account name of the user", + "name": "account", "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 account name of the user", - "name": "account", + "description": "the user firstname", + "name": "firstname", "type": "string" }, { - "description": "the user name", - "name": "username", + "description": "the api key of the user", + "name": "apikey", "type": "string" }, { - "description": "the ID of the role", - "name": "roleid", + "description": "the secret key of the user", + "name": "secretkey", "type": "string" }, { - "description": "the user lastname", - "name": "lastname", + "description": "the user email address", + "name": "email", "type": "string" }, { - "description": "the boolean value representing if the updating target is in caller's child domain", - "name": "iscallerchilddomain", - "type": "boolean" - }, - { - "description": "the date and time the user account was created", - "name": "created", - "type": "date" + "description": "the user state", + "name": "state", + "type": "string" }, { - "description": "the name of the role", - "name": "rolename", + "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", + "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 name", + "name": "username", + "type": "string" }, { - "description": "the domain name of the user", - "name": "domain", + "description": "the type of the role", + "name": "roletype", "type": "string" }, { @@ -106791,101 +108700,61 @@ "type": "boolean" }, { - "description": "the user ID", - "name": "id", - "type": "string" + "description": "the account type of the user", + "name": "accounttype", + "type": "integer" }, { - "description": "the account ID of the user", - "name": "accountid", + "description": "the name of the role", + "name": "rolename", "type": "string" }, { - "description": "the type of the role", - "name": "roletype", + "description": "the domain name of the user", + "name": "domain", "type": "string" }, { - "description": "the user state", - "name": "state", + "description": "the domain ID of the user", + "name": "domainid", "type": "string" }, { - "description": "the secret key of the user", - "name": "secretkey", + "description": "the date and time the user account was created", + "name": "created", + "type": "date" + }, + { + "description": "the ID of the role", + "name": "roleid", "type": "string" }, { - "description": "the source type of the user in lowercase, such as native, ldap, saml2", - "name": "usersource", + "description": "the account ID of the user", + "name": "accountid", "type": "string" }, { - "description": "the account type of the user", - "name": "accounttype", - "type": "short" + "description": "the boolean value representing if the updating target is in caller's child domain", + "name": "iscallerchilddomain", + "type": "boolean" }, { - "description": "the api key of the user", - "name": "apikey", + "description": "the user ID", + "name": "id", "type": "string" } ], "type": "list" }, - { - "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": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "id of the Domain the account belongs to", - "name": "domainid", - "type": "string" - }, - { - "description": "the total number of virtual machines that can be deployed by this account", - "name": "vmlimit", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the total number of projects being administrated by this account", - "name": "projecttotal", - "type": "long" - }, - { - "description": "the total memory (in MB) owned by account", - "name": "memorytotal", - "type": "long" - }, { "description": "the total number of projects available for administration by this account", "name": "projectavailable", "type": "string" }, { - "description": "the total number of networks available to be created for this account", - "name": "networkavailable", - "type": "string" - }, - { - "description": "the total primary storage space (in GiB) available to be used for this account", - "name": "primarystorageavailable", + "description": "the state of the account", + "name": "state", "type": "string" }, { @@ -106899,155 +108768,55 @@ "type": "string" }, { - "description": "the total number of networks the account can own", - "name": "networklimit", - "type": "string" - }, - { - "description": "the total primary storage space (in GiB) the account can own", - "name": "primarystoragelimit", - "type": "string" - }, - { - "description": "the total number of vpcs available to be created for this account", - "name": "vpcavailable", + "description": "the total number of public ip addresses available for this account to acquire", + "name": "ipavailable", "type": "string" }, { - "description": "the total number of projects the account can own", - "name": "projectlimit", + "description": "the total secondary storage space (in GiB) the account can own", + "name": "secondarystoragelimit", "type": "string" }, + {}, { - "description": "the total volume being used by this account", - "name": "volumetotal", - "type": "long" - }, - { - "description": "the total number of virtual machines deployed by this account", - "name": "vmtotal", - "type": "long" - }, - { - "description": "the total number of public ip addresses allocated for this account", - "name": "iptotal", + "description": "the total number of networks owned by account", + "name": "networktotal", "type": "long" }, - { - "description": "the total number of virtual machines available for this account to acquire", - "name": "vmavailable", - "type": "string" - }, - { - "description": "the total secondary storage space (in GiB) available to be used for this account", - "name": "secondarystorageavailable", - "type": "string" - }, - { - "description": "the total secondary storage space (in GiB) owned by account", - "name": "secondarystoragetotal", - "type": "float" - }, - { - "description": "true if account is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "the total number of snapshots which can be stored by this account", - "name": "snapshotlimit", - "type": "string" - }, - { - "description": "name of the Domain the account belongs to", - "name": "domain", - "type": "string" - }, - { - "description": "the total number of vpcs the account can own", - "name": "vpclimit", - "type": "string" - }, { "description": "the id of the account", "name": "id", "type": "string" }, { - "description": "the total memory (in MB) available to be created for this account", - "name": "memoryavailable", - "type": "string" - }, - { - "description": "the total number of public ip addresses this account can acquire", - "name": "iplimit", - "type": "string" - }, - { - "description": "the total volume which can be used by this account", - "name": "volumelimit", - "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 the account can own", - "name": "cpulimit", - "type": "string" - }, - { - "description": "the total number of snapshots available for this account", - "name": "snapshotavailable", + "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", + "description": "the total number of cpu cores owned by account", + "name": "cputotal", "type": "long" }, - { - "description": "the total number of cpu cores available to be created for this account", - "name": "cpuavailable", - "type": "string" - }, - { - "description": "the date when this account was created", - "name": "created", - "type": "date" - }, { "description": "true if the account requires cleanup", "name": "iscleanuprequired", "type": "boolean" }, - {}, { - "description": "the total memory (in MB) the account can own", - "name": "memorylimit", + "description": "the total number of vpcs available to be created for this account", + "name": "vpcavailable", "type": "string" }, { - "description": "the list of acl groups that account belongs to", - "name": "groups", - "type": "list" - }, - { - "description": "the ID of the role", - "name": "roleid", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the total number of snapshots stored by this account", - "name": "snapshottotal", + "description": "the total number of public ip addresses allocated for this account", + "name": "iptotal", "type": "long" - }, - { - "description": "the total secondary storage space (in GiB) the account can own", - "name": "secondarystoragelimit", - "type": "string" } ] }, @@ -107068,14 +108837,14 @@ "related": "", "response": [ { - "description": "the name of the storage pool", - "name": "name", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the state of the storage pool", - "name": "state", - "type": "storagepoolstatus" + "description": "the overprovisionfactor for the storage pool", + "name": "overprovisionfactor", + "type": "string" }, { "description": "true if the entity/resource has annotations", @@ -107083,54 +108852,64 @@ "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 hypervisor type of the storage pool", - "name": "hypervisor", + "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 total disk size of the storage pool", - "name": "disksizetotal", - "type": "long" + "description": "the state of the storage pool", + "name": "state", + "type": "storagepoolstatus" }, { - "description": "the name of the cluster for the storage pool", - "name": "clustername", + "description": "the tags for the storage pool", + "name": "tags", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the storage pool path", + "name": "path", + "type": "string" }, { - "description": "the IP address of the storage pool", - "name": "ipaddress", + "description": "the host's currently allocated disk size", + "name": "disksizeallocated", + "type": "long" + }, + { + "description": "the storage pool type", + "name": "type", "type": "string" }, { - "description": "the storage pool path", - "name": "path", + "description": "the Zone name of the storage pool", + "name": "zonename", "type": "string" }, { - "description": "the scope of the storage pool", - "name": "scope", + "description": "the Pod ID of the storage pool", + "name": "podid", "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 date and time the storage pool was created", - "name": "created", - "type": "date" + "description": "the hypervisor type of the storage pool", + "name": "hypervisor", + "type": "string" }, { "description": "IOPS CloudStack can provision from this storage pool", @@ -107138,29 +108917,24 @@ "type": "long" }, { - "description": "the host's currently used disk size", - "name": "disksizeused", + "description": "the total disk size of the storage pool", + "name": "disksizetotal", "type": "long" }, { - "description": "the ID of the cluster for the storage pool", - "name": "clusterid", - "type": "string" + "description": "the date and time the storage pool was created", + "name": "created", + "type": "date" }, { - "description": "the tags for the storage pool", - "name": "tags", + "description": "the name of the cluster for the storage pool", + "name": "clustername", "type": "string" }, {}, { - "description": "the storage pool type", - "name": "type", - "type": "string" - }, - { - "description": "the Pod name of the storage pool", - "name": "podname", + "description": "Storage provider for this pool", + "name": "provider", "type": "string" }, { @@ -107169,29 +108943,18 @@ "type": "string" }, { - "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", + "description": "the IP address of the storage pool", + "name": "ipaddress", "type": "string" }, { - "description": "the storage pool capabilities", - "name": "storagecapabilities", - "type": "map" + "description": "the host's currently used disk size", + "name": "disksizeused", + "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" }, { @@ -107200,14 +108963,20 @@ "type": "string" }, { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", + "description": "total min IOPS currently in use by volumes", + "name": "allocatediops", "type": "long" }, + {}, + { + "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 storage pool capabilities", + "name": "storagecapabilities", + "type": "map" } ] }, @@ -107228,143 +108997,153 @@ "related": "", "response": [ { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the version of scripts", + "name": "scriptsversion", + "type": "string" }, { "description": "the list of nics associated with the router", "name": "nic", "response": [ { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", "type": "string" }, { - "description": "the type of the nic", - "name": "type", + "description": "true if nic is default, false otherwise", + "name": "macaddress", "type": "string" }, { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" }, { - "description": "the IPv6 address of network", - "name": "ip6address", + "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", + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", "type": "string" }, { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", "type": "string" }, { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", + "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 netmask of the nic", - "name": "netmask", + "description": "the isolation uri of the nic", + "name": "isolationuri", "type": "string" }, { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "the type of the nic", + "name": "type", "type": "string" }, { - "description": "the gateway of the nic", - "name": "gateway", - "type": "string" + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "the ID of the nic", + "name": "id", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the netmask of the nic", + "name": "netmask", "type": "string" }, { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", "type": "string" }, { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "description": "the traffic type of the nic", + "name": "traffictype", "type": "string" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", "type": "string" }, { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", "type": "integer" }, { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", + "description": "the gateway of the nic", + "name": "gateway", "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": "Type of adapter if available", - "name": "adaptertype", - "type": "string" + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" }, { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "description": "the IPv6 address of network", + "name": "ip6address", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", "type": "string" }, { - "description": "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 ID of the nic", - "name": "id", + "description": "the name of the corresponding network", + "name": "networkname", "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" } ], "type": "set" @@ -107395,55 +109174,23 @@ "type": "string" }, { - "description": "Last executed health check result for the router", - "name": "healthcheckresults", - "response": [ - { - "description": "detailed response generated on running health check", - "name": "details", - "type": "string" - }, - { - "description": "the type of the health check - basic or advanced", - "name": "checktype", - "type": "string" - }, - { - "description": "result of the health check", - "name": "success", - "type": "boolean" - }, - { - "description": "the name of the health check on the router", - "name": "checkname", - "type": "string" - }, - { - "description": "the date this VPC was created", - "name": "lastupdated", - "type": "date" - } - ], - "type": "list" - }, - { - "description": "the name of VPC the router belongs to", - "name": "vpcname", + "description": "the link local MAC address for the router", + "name": "linklocalmacaddress", "type": "string" }, { - "description": "the second IPv6 DNS for the router", - "name": "ip6dns2", + "description": "the link local IP address for the router", + "name": "linklocalip", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the link local netmask for the router", + "name": "linklocalnetmask", "type": "string" }, { - "description": "the state of redundant virtual router", - "name": "redundantstate", + "description": "the first DNS for the router", + "name": "dns1", "type": "string" }, { @@ -107452,33 +109199,33 @@ "type": "string" }, { - "description": "the account associated with the router", - "name": "account", + "description": "the name of VPC the router belongs to", + "name": "vpcname", "type": "string" }, { - "description": "the Pod ID for the router", - "name": "podid", + "description": "the second IPv6 DNS for the router", + "name": "ip6dns2", "type": "string" }, { - "description": "the guest netmask for the router", - "name": "guestnetmask", + "description": "the hostname for the router", + "name": "hostname", "type": "string" }, { - "description": "the name of the router", - "name": "name", + "description": "the network domain for the router", + "name": "networkdomain", "type": "string" }, { - "description": "the template name for the router", - "name": "templatename", + "description": "the gateway for the router", + "name": "gateway", "type": "string" }, { - "description": "the network domain for the router", - "name": "networkdomain", + "description": "the version of the code / software in the router", + "name": "softwareversion", "type": "string" }, { @@ -107487,8 +109234,8 @@ "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" }, { @@ -107507,24 +109254,38 @@ "type": "string" }, { - "description": "the link local IP address for the router", - "name": "linklocalip", + "description": "the first IPv6 DNS for the router", + "name": "ip6dns1", "type": "string" }, - {}, { - "description": "the version of scripts", - "name": "scriptsversion", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, { - "description": "the ID of the corresponding public network", - "name": "publicnetworkid", + "description": "the ID of the corresponding guest network", + "name": "guestnetworkid", "type": "string" }, { - "description": "the first DNS for the router", - "name": "dns1", + "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 template ID for the router", + "name": "templateid", "type": "string" }, { @@ -107533,29 +109294,66 @@ "type": "string" }, { - "description": "the first IPv6 DNS for the router", - "name": "ip6dns1", - "type": "string" + "description": "Last executed health check result for the router", + "name": "healthcheckresults", + "response": [ + { + "description": "the date this VPC was created", + "name": "lastupdated", + "type": "date" + }, + { + "description": "the name of the health check on the router", + "name": "checkname", + "type": "string" + }, + { + "description": "the type of the health check - basic or advanced", + "name": "checktype", + "type": "string" + }, + { + "description": "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 Pod name for the router", - "name": "podname", + "description": "the public MAC address for the router", + "name": "publicmacaddress", "type": "string" }, { - "description": "the Zone ID for the router", - "name": "zoneid", + "description": "the name of the router", + "name": "name", "type": "string" }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "the guest MAC address for the router", "name": "guestmacaddress", "type": "string" }, { - "description": "the state of the router", - "name": "state", - "type": "state" + "description": "the Pod name for the router", + "name": "podname", + "type": "string" + }, + { + "description": "the id of the router", + "name": "id", + "type": "string" }, { "description": "the name of the service offering of the virtual machine", @@ -107568,18 +109366,13 @@ "type": "string" }, { - "description": "the id of the router", - "name": "id", - "type": "string" - }, - { - "description": "the ID of the corresponding guest network", - "name": "guestnetworkid", + "description": "the Zone ID for the router", + "name": "zoneid", "type": "string" }, { - "description": "VPC the router belongs to", - "name": "vpcid", + "description": "the public IP address for the router", + "name": "publicip", "type": "string" }, { @@ -107588,23 +109381,15 @@ "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "the name of the corresponding guest network", + "name": "guestnetworkname", "type": "string" }, + {}, + {}, { - "description": "the hostname for the router", - "name": "hostname", + "description": "role of the domain router", + "name": "role", "type": "string" }, { @@ -107613,44 +109398,43 @@ "type": "string" }, { - "description": "role of the domain router", - "name": "role", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the public MAC address for the router", - "name": "publicmacaddress", + "description": "the ID of the corresponding public network", + "name": "publicnetworkid", "type": "string" }, { - "description": "the link local netmask for the router", - "name": "linklocalnetmask", + "description": "the guest netmask for the router", + "name": "guestnetmask", "type": "string" }, - {}, { - "description": "the link local MAC address for the router", - "name": "linklocalmacaddress", + "description": "VPC the router belongs to", + "name": "vpcid", "type": "string" }, { - "description": "the gateway for the router", - "name": "gateway", + "description": "the account associated with the router", + "name": "account", "type": "string" }, { - "description": "the template ID for the router", - "name": "templateid", + "description": "the state of redundant virtual router", + "name": "redundantstate", "type": "string" }, { - "description": "if this router is an redundant virtual router", - "name": "isredundantrouter", - "type": "boolean" + "description": "the Pod ID for the router", + "name": "podid", + "type": "string" }, { - "description": "the public IP address for the router", - "name": "publicip", + "description": "the template name for the router", + "name": "templatename", "type": "string" } ] @@ -107660,14 +109444,6 @@ "isasync": true, "name": "updateSnapshotPolicy", "params": [ - { - "description": "an optional field, whether to the display the snapshot policy to the end user or not.", - "length": 255, - "name": "fordisplay", - "required": false, - "since": "4.4", - "type": "boolean" - }, { "description": "the ID of the snapshot policy", "length": 255, @@ -107676,6 +109452,14 @@ "required": false, "type": "uuid" }, + { + "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, @@ -107688,10 +109472,21 @@ "related": "", "response": [ { - "description": "the time zone of the snapshot policy", - "name": "timezone", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the ID of the snapshot policy", + "name": "id", "type": "string" }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + {}, { "description": "the list of resource tags associated", "name": "tags", @@ -107702,18 +109497,13 @@ "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, - { - "description": "the account associated with the tag", - "name": "account", + { + "description": "resource type", + "name": "resourcetype", "type": "string" }, { @@ -107722,42 +109512,51 @@ "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the 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", "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" } ], "type": "set" }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "time the snapshot is scheduled to be taken.", "name": "schedule", "type": "string" }, - {}, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "is this policy for display to the regular user", + "name": "fordisplay", "type": "boolean" }, { @@ -107765,35 +109564,20 @@ "name": "intervaltype", "type": "short" }, + {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the ID of the disk volume", + "name": "volumeid", + "type": "string" }, - {}, { "description": "maximum number of snapshots retained", "name": "maxsnaps", "type": "int" }, { - "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 ID of the disk volume", - "name": "volumeid", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the time zone of the snapshot policy", + "name": "timezone", "type": "string" } ] @@ -107804,7 +109588,7 @@ "name": "queryAsyncJobResult", "params": [ { - "description": "the ID of the asychronous job", + "description": "the ID of the asynchronous job", "length": 255, "name": "jobid", "related": "queryAsyncJobResult", @@ -107814,23 +109598,24 @@ ], "related": "", "response": [ + {}, { "description": "the result code for the job", "name": "jobresultcode", "type": "integer" }, { - "description": " the completed date of the job", - "name": "completed", - "type": "date" + "description": "the user that executed the async command", + "name": "userid", + "type": "string" }, { - "description": "the progress information of the PENDING job", - "name": "jobprocstatus", - "type": "integer" + "description": " the created date of the job", + "name": "created", + "type": "date" }, { - "description": "the current job status-should be 0 for PENDING", + "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, @@ -107839,31 +109624,41 @@ "name": "cmd", "type": "string" }, - {}, { - "description": "the unique ID of the instance/entity object related to the job", - "name": "jobinstanceid", + "description": "the result reason", + "name": "jobresult", + "type": "responseobject" + }, + { + "description": "the account that executed the async command", + "name": "accountid", "type": "string" }, { - "description": "the user that executed the async command", - "name": "userid", + "description": "the progress information of the PENDING job", + "name": "jobprocstatus", + "type": "integer" + }, + { + "description": "the unique ID of the instance/entity object related to the job", + "name": "jobinstanceid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", + "description": "the current job status-should be 0 for PENDING", "name": "jobstatus", "type": "integer" }, { - "description": " the created date of the job", - "name": "created", + "description": " the completed date of the job", + "name": "completed", "type": "date" }, + {}, { - "description": "the result reason", - "name": "jobresult", - "type": "responseobject" + "description": "the result type", + "name": "jobresulttype", + "type": "string" }, { "description": "the UUID of the latest async job acting on this object", @@ -107874,17 +109669,6 @@ "description": "the instance/entity object related to the job", "name": "jobinstancetype", "type": "string" - }, - {}, - { - "description": "the result type", - "name": "jobresulttype", - "type": "string" - }, - { - "description": "the account that executed the async command", - "name": "accountid", - "type": "string" } ] }, @@ -107894,18 +109678,18 @@ "name": "registerNetscalerControlCenter", "params": [ { - "description": "Credentials to reach netscaler controlcenter device", + "description": "Credentials to reach netscaler controlcenter device", "length": 255, - "name": "numretries", + "name": "password", "required": true, - "type": "integer" + "type": "string" }, { - "description": "URL of the netscaler controlcenter appliance.", + "description": "Credentials to reach netscaler controlcenter device", "length": 255, - "name": "ipaddress", + "name": "numretries", "required": true, - "type": "string" + "type": "integer" }, { "description": "Credentials to reach netscaler controlcenter device", @@ -107915,44 +109699,38 @@ "type": "string" }, { - "description": "Credentials to reach netscaler controlcenter device", + "description": "URL of the netscaler controlcenter appliance.", "length": 255, - "name": "password", + "name": "ipaddress", "required": true, "type": "string" } ], "related": "addNetscalerLoadBalancer,listNetscalerLoadBalancers", "response": [ - { - "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": "device state", "name": "lbdevicestate", "type": "string" }, + { + "description": "the physical network to which this netscaler device belongs to", + "name": "physicalnetworkid", + "type": "string" + }, { "description": "Used when NetScaler device is provider of EIP service. This parameter represents the list of pod's, for which there exists a policy based route on datacenter L3 router to route pod's subnet IP to a NetScaler device.", "name": "podids", "type": "list" }, { - "description": "true if NetScaler device is provisioned to be a GSLB service provider", - "name": "gslbprovider", - "type": "boolean" + "description": "public IP of the NetScaler representing GSLB site", + "name": "gslbproviderpublicip", + "type": "string" }, { - "description": "the private interface of the load balancer", - "name": "privateinterface", + "description": "device name", + "name": "lbdevicename", "type": "string" }, { @@ -107960,41 +109738,47 @@ "name": "lbdeviceid", "type": "string" }, + { + "description": "device capacity", + "name": "lbdevicecapacity", + "type": "long" + }, {}, { - "description": "private IP of the NetScaler representing GSLB site", - "name": "gslbproviderprivateip", + "description": "the management IP address of the external load balancer", + "name": "ipaddress", "type": "string" }, { - "description": "name of the provider", - "name": "provider", + "description": "the private interface of the load balancer", + "name": "privateinterface", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "true if NetScaler device is provisioned to be a GSLB service provider", + "name": "gslbprovider", + "type": "boolean" }, { - "description": "the physical network to which this netscaler device belongs to", - "name": "physicalnetworkid", + "description": "name of the provider", + "name": "provider", "type": "string" }, + {}, { - "description": "public IP of the NetScaler representing GSLB site", - "name": "gslbproviderpublicip", - "type": "string" + "description": "true if NetScaler device is provisioned exclusively to be a GSLB service provider", + "name": "isexclusivegslbprovider", + "type": "boolean" }, { - "description": "device name", - "name": "lbdevicename", + "description": "the public interface of the load balancer", + "name": "publicinterface", "type": "string" }, { - "description": "device capacity", - "name": "lbdevicecapacity", - "type": "long" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { "description": "true if device is dedicated for an account", @@ -108002,14 +109786,14 @@ "type": "boolean" }, { - "description": "the management IP address of the external load balancer", - "name": "ipaddress", + "description": "private IP of the NetScaler representing GSLB site", + "name": "gslbproviderprivateip", "type": "string" }, { - "description": "the public interface of the load balancer", - "name": "publicinterface", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ] }, @@ -108019,47 +109803,46 @@ "name": "listImageStores", "params": [ { - "description": "the image store provider", + "description": "the image store protocol", "length": 255, - "name": "provider", + "name": "protocol", "required": false, "type": "string" }, { - "description": "the image store protocol", + "description": "", "length": 255, - "name": "protocol", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { - "description": "the name of the image store", + "description": "", "length": 255, - "name": "name", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { - "description": "the Zone ID for the image store", + "description": "the image store provider", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "provider", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "page", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { - "description": "", + "description": "the name of the image store", "length": 255, - "name": "pagesize", + "name": "name", "required": false, - "type": "integer" + "type": "string" }, { "description": "read-only status of the image store", @@ -108071,28 +109854,24 @@ "type": "boolean" }, { - "description": "List by keyword", + "description": "the ID of the storage pool", "length": 255, - "name": "keyword", + "name": "id", + "related": "listImageStores", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "the ID of the storage pool", + "description": "the Zone ID for the image store", "length": 255, - "name": "id", - "related": "listImageStores", + "name": "zoneid", + "related": "listZones", "required": false, "type": "uuid" } ], "related": "", "response": [ - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, { "description": "the total disk size of the host", "name": "disksizetotal", @@ -108104,61 +109883,66 @@ "type": "string" }, { - "description": "the name of the image store", - "name": "name", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "defines if store is read-only", - "name": "readonly", - "type": "boolean" + "description": "the Zone ID of the image store", + "name": "zoneid", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the name of the image store", + "name": "name", "type": "string" }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - { - "description": "the host's currently used disk size", - "name": "disksizeused", - "type": "long" - }, { "description": "the url of the image store", "name": "url", "type": "string" }, - {}, - {}, { - "description": "the ID of the image store", - "name": "id", - "type": "string" + "description": "the scope of the image store", + "name": "scope", + "type": "scopetype" + }, + { + "description": "defines if store is read-only", + "name": "readonly", + "type": "boolean" }, { "description": "the provider name of the image store", "name": "providername", "type": "string" }, + {}, + { + "description": "the ID of the image store", + "name": "id", + "type": "string" + }, { "description": "the Zone name of the image store", "name": "zonename", "type": "string" }, { - "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 scope of the image store", - "name": "scope", - "type": "scopetype" + "description": "the host's currently used disk size", + "name": "disksizeused", + "type": "long" } ], "since": "4.2.0" @@ -108178,26 +109962,26 @@ } ], "response": [ - {}, - {}, - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - }, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + {}, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" } ] @@ -108208,16 +109992,16 @@ "name": "createCounter", "params": [ { - "description": "Source of the counter.", + "description": "Value of the counter e.g. oid in case of snmp.", "length": 255, - "name": "source", + "name": "value", "required": true, "type": "string" }, { - "description": "Value of the counter e.g. oid in case of snmp.", + "description": "Source of the counter.", "length": 255, - "name": "value", + "name": "source", "required": true, "type": "string" }, @@ -108231,18 +110015,12 @@ ], "related": "", "response": [ - { - "description": "Value in case of snmp or other specific counters.", - "name": "value", - "type": "string" - }, + {}, { "description": "Source of the counter.", "name": "source", "type": "string" }, - {}, - {}, { "description": "Name of the counter.", "name": "name", @@ -108254,19 +110032,25 @@ "type": "string" }, { - "description": "zone id of counter", - "name": "zoneid", + "description": "the id of the Counter", + "name": "id", "type": "string" }, { - "description": "the id of the Counter", - "name": "id", + "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": "zone id of counter", + "name": "zoneid", + "type": "string" } ] }, @@ -108277,23 +110061,23 @@ "params": [], "related": "", "response": [ + { + "description": "Event Type", + "name": "name", + "type": "string" + }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - {}, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - { - "description": "Event Type", - "name": "name", - "type": "string" - } + {}, + {} ] }, { @@ -108313,13 +110097,8 @@ "related": "", "response": [ { - "description": "the out-of-band management interface address", - "name": "address", - "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" }, { @@ -108328,56 +110107,61 @@ "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "true if out-of-band management is enabled for the host", + "name": "enabled", + "type": "boolean" }, { - "description": "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 operation result description", + "name": "description", "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 UUID of the latest async job acting on this object", - "name": "jobid", + "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 username", + "name": "username", "type": "string" }, { - "description": "the operation result description", - "name": "description", + "description": "the out-of-band management interface password", + "name": "password", "type": "string" }, + {}, { - "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 ID of the host", - "name": "hostid", + "description": "the out-of-band management interface address", + "name": "address", "type": "string" }, + {}, { - "description": "the out-of-band management interface powerState of the host", - "name": "powerstate", - "type": "powerstate" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the out-of-band management driver for the host", + "name": "driver", + "type": "string" } ], "since": "4.9.0" @@ -108388,51 +110172,53 @@ "name": "addCluster", "params": [ { - "description": "Name of virtual switch used for public traffic in the cluster. This would override zone wide traffic label setting.", + "description": "Name of virtual switch used for guest traffic in the cluster. This would override zone wide traffic label setting.", "length": 255, - "name": "publicvswitchname", + "name": "guestvswitchname", "required": false, "type": "string" }, { - "description": "the URL", + "description": "Ovm3 native pooling enabled for cluster", "length": 255, - "name": "url", + "name": "ovm3pool", "required": false, "type": "string" }, { - "description": "type of the cluster: CloudManaged, ExternalManaged", + "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": "clustertype", - "required": true, + "name": "guestvswitchtype", + "required": false, "type": "string" }, { - "description": "Name of virtual switch used for guest traffic in the cluster. This would override zone wide traffic label setting.", + "description": "the cluster name", "length": 255, - "name": "guestvswitchname", - "required": false, + "name": "clustername", + "required": true, "type": "string" }, { - "description": "Allocation state of this cluster for allocation of new resources", + "description": "the Pod ID for the host", "length": 255, - "name": "allocationstate", - "required": false, - "type": "string" + "name": "podid", + "related": "createManagementNetworkIpRange", + "required": true, + "type": "uuid" }, { - "description": "Type of virtual switch used for guest traffic in the cluster. Allowed values are, vmwaresvs (for VMware standard vSwitch) and vmwaredvs (for VMware distributed vSwitch)", + "description": "the Zone ID for the cluster", "length": 255, - "name": "guestvswitchtype", - "required": false, - "type": "string" + "name": "zoneid", + "related": "listZones", + "required": true, + "type": "uuid" }, { - "description": "Ovm3 native OCFS2 clustering enabled for cluster", + "description": "the username for the cluster", "length": 255, - "name": "ovm3cluster", + "name": "username", "required": false, "type": "string" }, @@ -108443,13 +110229,6 @@ "required": false, "type": "string" }, - { - "description": "the cluster name", - "length": 255, - "name": "clustername", - "required": true, - "type": "string" - }, { "description": "the password for the host", "length": 255, @@ -108458,38 +110237,37 @@ "type": "string" }, { - "description": "Ovm3 vip to use for pool (and cluster)", + "description": "the password for the VSM associated with this cluster", "length": 255, - "name": "ovm3vip", + "name": "vsmpassword", "required": false, "type": "string" }, { - "description": "hypervisor type of the cluster: XenServer,KVM,VMware,Hyperv,BareMetal,Simulator,Ovm3", + "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": "hypervisor", - "required": true, + "name": "publicvswitchtype", + "required": false, "type": "string" }, { - "description": "the Pod ID for the host", + "description": "type of the cluster: CloudManaged, ExternalManaged", "length": 255, - "name": "podid", - "related": "createManagementNetworkIpRange", + "name": "clustertype", "required": true, - "type": "uuid" + "type": "string" }, { - "description": "Ovm3 native pooling enabled for cluster", + "description": "Ovm3 native OCFS2 clustering enabled for cluster", "length": 255, - "name": "ovm3pool", + "name": "ovm3cluster", "required": false, "type": "string" }, { - "description": "the username for the cluster", + "description": "Name of virtual switch used for public traffic in the cluster. This would override zone wide traffic label setting.", "length": 255, - "name": "username", + "name": "publicvswitchname", "required": false, "type": "string" }, @@ -108501,24 +110279,30 @@ "type": "string" }, { - "description": "the Zone ID for the cluster", + "description": "hypervisor type of the cluster: XenServer,KVM,VMware,Hyperv,BareMetal,Simulator,Ovm3", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "hypervisor", "required": true, - "type": "uuid" + "type": "string" }, { - "description": "Type of virtual switch used for public traffic in the cluster. Allowed values are, vmwaresvs (for VMware standard vSwitch) and vmwaredvs (for VMware distributed vSwitch)", + "description": "Ovm3 vip to use for pool (and cluster)", "length": 255, - "name": "publicvswitchtype", + "name": "ovm3vip", "required": false, "type": "string" }, { - "description": "the password for the VSM associated with this cluster", + "description": "the URL", "length": 255, - "name": "vsmpassword", + "name": "url", + "required": false, + "type": "string" + }, + { + "description": "Allocation state of this cluster for allocation of new resources", + "length": 255, + "name": "allocationstate", "required": false, "type": "string" } @@ -108526,42 +110310,18 @@ "related": "", "response": [ { - "description": "The cpu overcommit ratio of the cluster", - "name": "cpuovercommitratio", - "type": "string" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the Pod ID of the cluster", - "name": "podid", - "type": "string" - }, - { - "description": "the hypervisor type of the cluster", - "name": "hypervisortype", - "type": "string" - }, - { - "description": "Ovm3 VIP to use for pooling and/or clustering", - "name": "ovm3vip", + "description": "the Zone name of the cluster", + "name": "zonename", "type": "string" }, + {}, { "description": "the capacity of the Cluster", "name": "capacity", "response": [ { - "description": "the Zone ID", - "name": "zoneid", + "description": "the Cluster name", + "name": "clustername", "type": "string" }, { @@ -108570,13 +110330,13 @@ "type": "string" }, { - "description": "the Zone name", - "name": "zonename", - "type": "string" + "description": "the capacity currently in allocated", + "name": "capacityallocated", + "type": "long" }, { - "description": "the Cluster name", - "name": "clustername", + "description": "the Zone ID", + "name": "zoneid", "type": "string" }, { @@ -108585,51 +110345,46 @@ "type": "long" }, { - "description": "the capacity currently in allocated", - "name": "capacityallocated", - "type": "long" - }, - { - "description": "the capacity name", - "name": "name", + "description": "the Zone name", + "name": "zonename", "type": "string" }, { - "description": "the capacity type", - "name": "type", - "type": "short" + "description": "the percentage of capacity currently in use", + "name": "percentused", + "type": "string" }, { "description": "the Pod ID", "name": "podid", "type": "string" }, + { + "description": "the Pod name", + "name": "podname", + "type": "string" + }, { "description": "the total capacity available", "name": "capacitytotal", "type": "long" }, { - "description": "the percentage of capacity currently in use", - "name": "percentused", - "type": "string" + "description": "the capacity type", + "name": "type", + "type": "short" }, { - "description": "the Pod name", - "name": "podname", + "description": "the capacity name", + "name": "name", "type": "string" } ], "type": "list" }, { - "description": "the Zone ID of the cluster", - "name": "zoneid", - "type": "string" - }, - { - "description": "the allocation state of the cluster", - "name": "allocationstate", + "description": "whether this cluster is managed by cloudstack", + "name": "managedstate", "type": "string" }, { @@ -108638,13 +110393,13 @@ "type": "string" }, { - "description": "the type of the cluster", - "name": "clustertype", + "description": "the cluster ID", + "name": "id", "type": "string" }, { - "description": "The memory overcommit ratio of the cluster", - "name": "memoryovercommitratio", + "description": "The cpu overcommit ratio of the cluster", + "name": "cpuovercommitratio", "type": "string" }, { @@ -108653,32 +110408,61 @@ "type": "integer" }, { - "description": "the Pod name of the cluster", - "name": "podname", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "Ovm3 VIP to use for pooling and/or clustering", + "name": "ovm3vip", "type": "string" }, { - "description": "whether this cluster is managed by cloudstack", - "name": "managedstate", + "description": "the type of the cluster", + "name": "clustertype", "type": "string" }, { - "description": "the Zone name of the cluster", - "name": "zonename", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the Pod ID of the cluster", + "name": "podid", + "type": "string" + }, + { + "description": "the Zone ID of the cluster", + "name": "zoneid", + "type": "string" + }, + { + "description": "The memory overcommit ratio of the cluster", + "name": "memoryovercommitratio", + "type": "string" + }, + { + "description": "the hypervisor type of the cluster", + "name": "hypervisortype", + "type": "string" + }, + { + "description": "the Pod name of the cluster", + "name": "podname", "type": "string" }, - {}, { "description": "Meta data associated with the zone (key/value pairs)", "name": "resourcedetails", "type": "map" }, - {}, { - "description": "the cluster ID", - "name": "id", + "description": "the allocation state of the cluster", + "name": "allocationstate", "type": "string" - } + }, + {} ] }, { @@ -108690,28 +110474,28 @@ "description": "Id of the Traffic Monitor Host.", "length": 255, "name": "id", - "related": "reconnectHost,addBaremetalHost", + "related": "addBaremetalHost,reconnectHost", "required": true, "type": "uuid" } ], "response": [ - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, + { + "description": "the 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", @@ -108744,146 +110528,265 @@ ], "related": "destroyVirtualMachine,scaleVirtualMachine,startVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines", "response": [ + { + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", + "type": "string" + }, + { + "description": "the account associated with the virtual machine", + "name": "account", + "type": "string" + }, + { + "description": "the user's name who deployed the virtual machine", + "name": "username", + "type": "string" + }, + { + "description": "ssh key-pairs", + "name": "keypairs", + "type": "string" + }, + { + "description": "the ID of the disk offering of the virtual machine", + "name": "diskofferingid", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", + "type": "string" + }, {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", + "type": "string" + }, + { + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", + "type": "string" + }, + { + "description": "the state of the virtual machine", + "name": "state", + "type": "string" + }, + { + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", "type": "integer" }, { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", + "description": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" + }, + { + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, { - "description": "the vgpu type used by the virtual machine", - "name": "vgpu", + "description": "the user's ID who deployed the virtual machine", + "name": "userid", "type": "string" }, { - "description": "the pool type of the virtual machine", - "name": "pooltype", + "description": "the ID of the host for the virtual machine", + "name": "hostid", "type": "string" }, { - "description": "the outgoing network traffic on the host", - "name": "networkkbswrite", + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", + "type": "string" + }, + { + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" + }, + { + "description": "the group name of the virtual machine", + "name": "group", + "type": "string" + }, + { + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" + }, + { + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", "type": "long" }, + { + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", + "type": "string" + }, + { + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", + "type": "string" + }, + { + "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": "State of the Service from LB rule", "name": "servicestate", "type": "string" }, + { + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", + "type": "string" + }, + { + "description": "the name of the host for the virtual machine", + "name": "hostname", + "type": "string" + }, + { + "description": "Guest vm Boot Mode", + "name": "bootmode", + "type": "string" + }, + { + "description": "device type of the root volume", + "name": "rootdevicetype", + "type": "string" + }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the name of the disk offering of the virtual machine", + "name": "diskofferingname", + "type": "string" + }, { "description": "the amount of the vm's CPU currently used", "name": "cpuused", "type": "string" }, { - "description": "the account associated with the virtual machine", - "name": "account", + "description": "the read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" + }, + { + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", "type": "string" }, { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", "type": "boolean" }, { - "description": "the read (bytes) of disk on the vm", - "name": "diskkbsread", + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", "type": "long" }, { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", + "description": "the project name of the vm", + "name": "project", "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 ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - } - ], - "type": "set" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "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 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": "OS name of the vm", + "name": "osdisplayname", + "type": "string" + }, + { + "description": "the group ID of the virtual machine", + "name": "groupid", + "type": "string" }, + {}, { "description": "list of security groups associated with the virtual machine", "name": "securitygroup", "response": [ { - "description": "the ID of the security group", - "name": "id", + "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 domain ID of the security group", + "name": "domainid", + "type": "string" + }, + { + "description": "the description of the security group", + "name": "description", + "type": "string" }, { "description": "the list of 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 protocol of the security group rule", + "name": "protocol", + "type": "string" }, { "description": "the type of the ICMP message response", @@ -108891,19 +110794,9 @@ "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 code for the ICMP message response", @@ -108911,13 +110804,18 @@ "type": "integer" }, { - "description": "the protocol of the security group rule", - "name": "protocol", + "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", + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", "type": "string" }, { @@ -108925,13 +110823,8 @@ "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", + "description": "tag value", + "name": "value", "type": "string" }, { @@ -108940,13 +110833,13 @@ "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { @@ -108955,13 +110848,13 @@ "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { @@ -108970,17 +110863,27 @@ "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", "type": "string" } ], "type": "set" }, { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" + "description": "account owning the security group rule", + "name": "account", + "type": "string" + }, + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" } ], "type": "set" @@ -108990,16 +110893,6 @@ "name": "account", "type": "string" }, - { - "description": "the description of the security group", - "name": "description", - "type": "string" - }, - { - "description": "the domain name of the security group", - "name": "domain", - "type": "string" - }, { "description": "the project id of the group", "name": "projectid", @@ -109020,8 +110913,13 @@ "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "tag value", + "name": "value", "type": "string" }, { @@ -109035,8 +110933,8 @@ "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { @@ -109045,37 +110943,37 @@ "type": "string" }, { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" } ], "type": "set" }, - { - "description": "the domain ID of the security group", - "name": "domainid", - "type": "string" - }, { "description": "the list of ingress rules associated with the security group", "name": "ingressrule", "response": [ + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, { "description": "the protocol of the security group rule", "name": "protocol", @@ -109091,8 +110989,13 @@ "name": "tags", "response": [ { - "description": "customer associated with the tag", - "name": "customer", + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", "type": "string" }, { @@ -109101,13 +111004,13 @@ "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { @@ -109115,47 +111018,32 @@ "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", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" } ], "type": "set" }, { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, - { - "description": "the id of the security group rule", - "name": "ruleid", + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", "type": "string" }, { @@ -109164,8 +111052,8 @@ "type": "string" }, { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", + "description": "security group name", + "name": "securitygroupname", "type": "string" }, { @@ -109174,232 +111062,240 @@ "type": "integer" }, { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" } ], "type": "set" }, { - "description": "the project name of the group", - "name": "project", - "type": "string" + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" }, { "description": "the list of virtualmachine ids associated with this securitygroup", "name": "virtualmachineids", "type": "set" + }, + { + "description": "the ID of the security group", + "name": "id", + "type": "string" + }, + { + "description": "the domain name of the security group", + "name": "domain", + "type": "string" } ], "type": "set" }, { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", + "description": "the pool type of the virtual machine", + "name": "pooltype", "type": "string" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "the name of the virtual machine", + "name": "name", "type": "string" }, { - "description": "the incoming network traffic on the vm", - "name": "networkkbsread", + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", "type": "long" }, { - "description": "OS type id of the vm", - "name": "ostypeid", - "type": "string" + "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", + "type": "long" }, { - "description": "the group name of the virtual machine", - "name": "group", + "description": "the 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": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", + "type": "boolean" + }, + { + "description": "the project id of the vm", + "name": "projectid", "type": "string" }, { - "description": "device type of the root volume", - "name": "rootdevicetype", + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" + }, + { + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", "type": "string" }, { - "description": "the list of nics associated with vm", - "name": "nic", + "description": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", "response": [ { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "the project name of the affinity group", + "name": "project", "type": "string" }, { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" - }, - { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "description": "the domain 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 project ID of the affinity group", + "name": "projectid", "type": "string" }, { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - }, - { - "description": "the IPv6 address of network", - "name": "ip6address", + "description": "the name of the affinity group", + "name": "name", "type": "string" }, { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "the ID of the affinity group", + "name": "id", "type": "string" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "the type of the affinity group", + "name": "type", "type": "string" }, { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" - }, - { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "the domain name of the affinity group", + "name": "domain", "type": "string" }, { - "description": "the netmask of the nic", - "name": "netmask", + "description": "the description of the affinity group", + "name": "description", "type": "string" }, { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "the account owning the affinity group", + "name": "account", "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": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" + } + ], + "type": "set" + }, + { + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" + }, + { + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", + "type": "string" + }, + { + "description": "the list of resource tags associated", + "name": "tags", + "response": [ { - "description": "the gateway of the nic", - "name": "gateway", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the ip address of the nic", - "name": "ipaddress", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the ID of the nic", - "name": "id", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the type of the nic", - "name": "type", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" - }, - { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" } ], "type": "set" }, { - "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": "Os type ID of the virtual machine", + "name": "guestosid", "type": "string" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", "type": "string" }, { - "description": "the name of the virtual machine", - "name": "name", - "type": "string" + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" }, { - "description": "the read (io) of disk on the vm", - "name": "diskioread", + "description": "the memory used by the VM in KiB", + "name": "memorykbs", "type": "long" }, { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "OS type id of the vm", + "name": "ostypeid", "type": "string" }, { - "description": "the project name of the vm", - "name": "project", - "type": "string" + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" }, { "description": "the name of the template for the virtual machine", @@ -109407,201 +111303,155 @@ "type": "string" }, { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", - "type": "string" - }, - { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", - "type": "string" - }, - {}, - { - "description": "the number of cpu this virtual machine is running with", - "name": "cpunumber", - "type": "integer" - }, - { - "description": "the ID of the disk offering of the virtual machine", - "name": "diskofferingid", - "type": "string" - }, - { - "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 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 target memory in vm", - "name": "memorytargetkbs", - "type": "long" - }, - { - "description": "Os type ID of the virtual machine", - "name": "guestosid", - "type": "string" - }, - { - "description": "the write (io) of disk on the vm", - "name": "diskiowrite", - "type": "long" - }, - { - "description": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", + "description": "the list of nics associated with vm", + "name": "nic", "response": [ { - "description": "the name of the affinity group", - "name": "name", + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", "type": "string" }, { - "description": "the project name of the affinity group", - "name": "project", + "description": "the name of the corresponding network", + "name": "networkname", + "type": "string" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + }, + { + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "the isolation uri of the nic", + "name": "isolationuri", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "macaddress", + "type": "string" + }, + { + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", + "type": "string" + }, + { + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", + "type": "string" + }, + { + "description": "the type of the nic", + "name": "type", + "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": "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": "the ID of the nic", + "name": "id", + "type": "string" + }, + { + "description": "the ID of the corresponding network", + "name": "networkid", + "type": "string" + }, + { + "description": "the gateway of the nic", + "name": "gateway", + "type": "string" + }, + { + "description": "the netmask of the nic", + "name": "netmask", "type": "string" }, { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", "type": "list" }, { - "description": "the domain ID of the affinity group", - "name": "domainid", + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", "type": "string" }, { - "description": "the domain name of the affinity group", - "name": "domain", - "type": "string" + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "the type of the affinity group", - "name": "type", + "description": "the traffic type of the nic", + "name": "traffictype", "type": "string" }, { - "description": "the description of the affinity group", - "name": "description", + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "type": "string" }, { - "description": "the account owning the affinity group", - "name": "account", + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", "type": "string" }, { - "description": "the project ID of the affinity group", - "name": "projectid", + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { - "description": "the ID of the affinity group", - "name": "id", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" } ], "type": "set" }, { - "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", - "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": "the internal memory that's free in vm or zero if it can not be calculated", - "name": "memoryintfreekbs", - "type": "long" - }, - { - "description": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" - }, - { - "description": "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 name of the service offering of the virtual machine", - "name": "serviceofferingname", - "type": "string" - }, - { - "description": "the group ID of the virtual machine", - "name": "groupid", - "type": "string" - }, - { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", - "type": "boolean" - }, - { - "description": "ssh key-pair", - "name": "keypair", - "type": "string" - }, - { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", - "type": "string" - }, - { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", - "type": "string" - }, - { - "description": "the speed of each cpu", - "name": "cpuspeed", - "type": "integer" - }, - { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", - "type": "string" - }, - { - "description": "the ID of the host for the virtual machine", - "name": "hostid", + "description": "the ID of the virtual machine", + "name": "id", "type": "string" }, { @@ -109609,91 +111459,35 @@ "name": "boottype", "type": "string" }, - {}, - { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", - "type": "string" - }, - { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" - }, - { - "description": "the password (if exists) of the virtual machine", - "name": "password", - "type": "string" - }, - { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", - "type": "boolean" - }, - { - "description": "the write (bytes) of disk on the vm", - "name": "diskkbswrite", - "type": "long" - }, - { - "description": "the name of the disk offering of the virtual machine", - "name": "diskofferingname", - "type": "string" - }, - { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" - }, - { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" - }, { - "description": "the ID of the virtual machine", - "name": "id", + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", "type": "string" }, { - "description": "the name of the host for the virtual machine", - "name": "hostname", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "the memory used by the vm", - "name": "memorykbs", + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", "type": "long" }, { - "description": "the state of the virtual machine", - "name": "state", - "type": "string" - }, - { - "description": "OS name of the vm", - "name": "osdisplayname", - "type": "string" - }, - { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", + "description": "the ID of the availablility zone for the virtual machine", + "name": "zoneid", "type": "string" }, { "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", - "type": "string" - }, - { - "description": "the user's name who deployed the virtual machine", - "name": "username", + "name": "publicip", "type": "string" }, { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", - "type": "string" + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" } ] }, @@ -109713,89 +111507,49 @@ ], "related": "", "response": [ - { - "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 number of virtual machines deployed by this project", - "name": "vmtotal", - "type": "long" - }, - { - "description": "the total memory (in MB) available to be created for this project", - "name": "memoryavailable", - "type": "string" - }, - { - "description": "the total volume available for this project", - "name": "volumeavailable", - "type": "string" - }, - { - "description": "the total number of snapshots available for this project", - "name": "snapshotavailable", - "type": "string" - }, - { - "description": "the total number of networks the project can own", - "name": "networklimit", - "type": "string" - }, { "description": "Base64 string representation of the resource icon", "name": "icon", "type": "resourceiconresponse" }, { - "description": "the date this project was created", - "name": "created", - "type": "date" - }, - { - "description": "the total primary storage space (in GiB) the project can own", - "name": "primarystoragelimit", + "description": "the total number of public ip addresses available for this project to acquire", + "name": "ipavailable", "type": "string" }, { - "description": "the total number of networks available to be created for this project", - "name": "networkavailable", + "description": "the total volume which can be used by this project", + "name": "volumelimit", "type": "string" }, { - "description": "the total memory (in MB) owned by project", - "name": "memorytotal", - "type": "long" + "description": "the id of the project", + "name": "id", + "type": "string" }, { - "description": "the state of the project", - "name": "state", + "description": "the total volume available for this project", + "name": "volumeavailable", "type": "string" }, { - "description": "the total number of vpcs the project can own", - "name": "vpclimit", + "description": "the project account name of the project", + "name": "projectaccountname", "type": "string" }, { - "description": "the id of the project", - "name": "id", + "description": "the name of the project", + "name": "name", "type": "string" }, { - "description": "the total secondary storage space (in GiB) the project can own", - "name": "secondarystoragelimit", + "description": "the total number of snapshots available for this project", + "name": "snapshotavailable", "type": "string" }, { - "description": "the total primary storage space (in GiB) available to be used for this project", - "name": "primarystorageavailable", + "description": "the total secondary storage space (in GiB) available to be used for this project", + "name": "secondarystorageavailable", "type": "string" }, { @@ -109804,70 +111558,34 @@ "type": "float" }, { - "description": "the total number of virtual machines running for this project", - "name": "vmrunning", - "type": "integer" - }, - { - "description": "the displaytext of the project", - "name": "displaytext", - "type": "string" - }, - { - "description": "the domain id the project belongs to", - "name": "domainid", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the total number of public ip addresses allocated for this project", - "name": "iptotal", + "description": "the total number of virtual machines deployed by this project", + "name": "vmtotal", "type": "long" }, - {}, - { - "description": "the total number of cpu cores available to be created for this project", - "name": "cpuavailable", - "type": "string" - }, - { - "description": "the project account name of the project", - "name": "projectaccountname", - "type": "string" - }, - {}, - { - "description": "the total number of public ip addresses this project can acquire", - "name": "iplimit", - "type": "string" - }, { - "description": "the total number of networks owned by project", - "name": "networktotal", + "description": "the total memory (in MB) owned by project", + "name": "memorytotal", "type": "long" }, + {}, { - "description": "the total number of virtual machines available for this project to acquire", - "name": "vmavailable", + "description": "the total secondary storage space (in GiB) the project can own", + "name": "secondarystoragelimit", "type": "string" }, { - "description": "the total number of virtual machines that can be deployed by this project", - "name": "vmlimit", + "description": "the total number of cpu cores available to be created for this project", + "name": "cpuavailable", "type": "string" }, { - "description": "the total number of snapshots which can be stored by this project", - "name": "snapshotlimit", - "type": "string" + "description": "the date this project was created", + "name": "created", + "type": "date" }, { - "description": "the total volume being used by this project", - "name": "volumetotal", + "description": "the total number of templates which have been created by this project", + "name": "templatetotal", "type": "long" }, { @@ -109876,48 +111594,43 @@ "type": "long" }, { - "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 domain name where the project belongs to", - "name": "domain", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the total number of public ip addresses available for this project to acquire", - "name": "ipavailable", - "type": "string" + "description": "the total number of snapshots stored by this project", + "name": "snapshottotal", + "type": "long" }, { - "description": "the total volume which can be used by this project", - "name": "volumelimit", + "description": "the total primary storage space (in GiB) available to be used for this project", + "name": "primarystorageavailable", "type": "string" }, { - "description": "the total number of templates available to be created by this project", - "name": "templateavailable", + "description": "the displaytext of the project", + "name": "displaytext", "type": "string" }, { - "description": "the total number of templates which have been created by this project", - "name": "templatetotal", - "type": "long" - }, - { - "description": "the total number of virtual machines stopped for this project", - "name": "vmstopped", - "type": "integer" + "description": "the total number of virtual machines that can be deployed by this project", + "name": "vmlimit", + "type": "string" }, { - "description": "the total memory (in MB) the project can own", - "name": "memorylimit", + "description": "the total primary storage space (in GiB) the project can own", + "name": "primarystoragelimit", "type": "string" }, { - "description": "the total secondary storage space (in GiB) available to be used for this project", - "name": "secondarystorageavailable", + "description": "the total number of templates which can be created by this project", + "name": "templatelimit", "type": "string" }, { @@ -109925,87 +111638,168 @@ "name": "tags", "response": [ { - "description": "tag key name", - "name": "key", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "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": "id of the resource", - "name": "resourceid", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" } ], "type": "list" }, { - "description": "the total number of snapshots stored by this project", - "name": "snapshottotal", + "description": "the total number of networks owned by project", + "name": "networktotal", "type": "long" }, { - "description": "the total number of vpcs available to be created for this project", - "name": "vpcavailable", + "description": "the total number of snapshots which can be stored by this project", + "name": "snapshotlimit", "type": "string" }, { - "description": "the name of the project", - "name": "name", + "description": "the total memory (in MB) the project can own", + "name": "memorylimit", + "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 this project can acquire", + "name": "iplimit", + "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", + "type": "string" + }, + { + "description": "the total number of templates available to be created by this project", + "name": "templateavailable", + "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 volume being used by this project", + "name": "volumetotal", + "type": "long" + }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "the total number of templates which can be created by this project", - "name": "templatelimit", + "description": "the total number of networks the project can own", + "name": "networklimit", + "type": "string" + }, + {}, + { + "description": "the total memory (in MB) available to be created for this project", + "name": "memoryavailable", "type": "string" }, { - "description": "the total primary storage space (in GiB) owned by project", - "name": "primarystoragetotal", + "description": "the total number of networks available to be created for this project", + "name": "networkavailable", + "type": "string" + }, + { + "description": "the total number of vpcs owned by project", + "name": "vpctotal", "type": "long" + }, + { + "description": "the total number of vpcs available to be created for this project", + "name": "vpcavailable", + "type": "string" + }, + { + "description": "the total number of vpcs the project can own", + "name": "vpclimit", + "type": "string" + }, + { + "description": "the domain id the project belongs to", + "name": "domainid", + "type": "string" + }, + { + "description": "the state of the project", + "name": "state", + "type": "string" + }, + { + "description": "the total number of virtual machines running for this project", + "name": "vmrunning", + "type": "integer" + }, + { + "description": "the total number of cpu cores the project can own", + "name": "cpulimit", + "type": "string" } ], "since": "3.0.0" @@ -110025,27 +111819,27 @@ } ], "response": [ - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, {}, {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, { "description": "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" } ] }, @@ -110055,24 +111849,17 @@ "name": "listDedicatedHosts", "params": [ { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, - { - "description": "List by keyword", + "description": "the name of the account associated with the host. Must be used with domainId.", "length": 255, - "name": "keyword", + "name": "account", "required": false, "type": "string" }, { - "description": "the ID of the domain associated with the host", + "description": "the ID of the host", "length": 255, - "name": "domainid", - "related": "listDomains", + "name": "hostid", + "related": "addBaremetalHost,reconnectHost", "required": false, "type": "uuid" }, @@ -110085,137 +111872,86 @@ "type": "uuid" }, { - "description": "the ID of the host", + "description": "", "length": 255, - "name": "hostid", - "related": "reconnectHost,addBaremetalHost", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "the name of the account associated with the host. Must be used with domainId.", + "description": "", "length": 255, - "name": "account", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { - "description": "", + "description": "the ID of the domain associated with the host", "length": 255, - "name": "page", + "name": "domainid", + "related": "listDomains", "required": false, - "type": "integer" + "type": "uuid" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" } ], "related": "", "response": [ {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the Account ID of the host", - "name": "accountid", - "type": "string" - }, - { - "description": "the Dedication Affinity Group ID of the host", - "name": "affinitygroupid", - "type": "string" - }, { "description": "the domain ID of the host", "name": "domainid", "type": "string" }, - { - "description": "the ID of the dedicated resource", - "name": "id", - "type": "string" - }, { "description": "the name of the host", "name": "hostname", "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" - } - ] - }, - { - "description": "Get diagnostics and files from system VMs", - "isasync": true, - "name": "getDiagnosticsData", - "params": [ - { - "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" }, { - "description": "The ID of the system VM instance to retrieve diagnostics data files from", - "length": 255, - "name": "targetid", - "related": "", - "required": true, - "type": "uuid" - } - ], - "related": "", - "response": [ + "description": "the Dedication Affinity Group ID of the host", + "name": "affinitygroupid", + "type": "string" + }, { - "description": "Storage URL to download retrieve diagnostics data files", - "name": "url", + "description": "the Account ID of the host", + "name": "accountid", "type": "string" }, - {}, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the ID of the dedicated resource", + "name": "id", "type": "string" }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" + }, + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" } - ], - "since": "4.14.0.0" + ] }, { "description": "upload an existing ISO into the CloudStack cloud.", "isasync": false, "name": "getUploadParamsForIso", "params": [ - { - "description": "the ID of the zone you wish to register the ISO to.", - "length": 255, - "name": "zoneid", - "related": "listZones", - "required": true, - "type": "uuid" - }, - { - "description": "the checksum value of this volume/template The parameter containing the checksum will be considered a MD5sum if it is not prefixed\n and just a plain ascii/utf8 representation of a hexadecimal string. If it is required to\n use another algorithm the hexadecimal string is to be prefixed with a string of the form,\n \"{}\", not including the double quotes. In this is the exact string\n representing the java supported algorithm, i.e. MD5 or SHA-256. Note that java does not\n contain an algorithm called SHA256 or one called sha-256, only SHA-256.", - "length": 255, - "name": "checksum", - "required": false, - "type": "string" - }, { "description": "the ID of the OS type that best represents the OS of this ISO. If the ISO is bootable this parameter needs to be passed", "length": 255, @@ -110225,54 +111961,47 @@ "type": "uuid" }, { - "description": "the display text of the ISO. This is usually used for display purposes.", - "length": 4096, - "name": "displaytext", - "required": true, - "type": "string" - }, - { - "description": "an optional accountName. Must be used with domainId.", + "description": "the name of the ISO", "length": 255, - "name": "account", - "required": false, + "name": "name", + "required": true, "type": "string" }, { - "description": "the format for the volume/template. Possible values include QCOW2, OVA, and VHD.", + "description": "the name of the volume/template", "length": 255, - "name": "format", + "name": "name", "required": true, "type": "string" }, { - "description": "true if you want this ISO to be featured", + "description": "true if the ISO or its derivatives are extractable; default is false", "length": 255, - "name": "isfeatured", + "name": "isextractable", "required": false, "type": "boolean" }, { - "description": "true if the ISO or its derivatives are extractable; default is false", + "description": "true if this ISO is bootable. If not passed explicitly its assumed to be true", "length": 255, - "name": "isextractable", + "name": "bootable", "required": false, "type": "boolean" }, { - "description": "Upload volume/template for the project", + "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": "projectid", - "related": "", + "name": "checksum", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "true if this ISO is bootable. If not passed explicitly its assumed to be true", + "description": "the ID of the zone you wish to register the ISO to.", "length": 255, - "name": "bootable", - "required": false, - "type": "boolean" + "name": "zoneid", + "related": "listZones", + "required": true, + "type": "uuid" }, { "description": "the ID of the zone the volume/template is to be hosted on", @@ -110283,9 +112012,17 @@ "type": "uuid" }, { - "description": "the name of the volume/template", + "description": "Upload volume/template for the project", "length": 255, - "name": "name", + "name": "projectid", + "related": "", + "required": false, + "type": "uuid" + }, + { + "description": "the format for the volume/template. Possible values include QCOW2, OVA, and VHD.", + "length": 255, + "name": "format", "required": true, "type": "string" }, @@ -110297,6 +112034,20 @@ "required": false, "type": "uuid" }, + { + "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": true, + "type": "string" + }, { "description": "true if you want to register the ISO to be publicly available to all users, false otherwise.", "length": 255, @@ -110305,54 +112056,97 @@ "type": "boolean" }, { - "description": "the name of the ISO", + "description": "an optional accountName. Must be used with domainId.", "length": 255, - "name": "name", - "required": true, + "name": "account", + "required": false, "type": "string" } ], "related": "", "response": [ + { + "description": "POST url to upload the file to", + "name": "postURL", + "type": "url" + }, { "description": "signature to be sent in the POST request.", "name": "signature", "type": "string" }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "the timestamp after which the signature expires", "name": "expires", "type": "string" }, - {}, - {}, { "description": "the template/volume ID", "name": "id", "type": "uuid" }, + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + {}, { "description": "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 status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "POST url to upload the file to", - "name": "postURL", - "type": "url" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Storage URL to download retrieve diagnostics data files", + "name": "url", "type": "string" - } + }, + {} ], - "since": "4.13" + "since": "4.14.0.0" }, { "description": "Deletes a autoscale vm group.", @@ -110369,26 +112163,26 @@ } ], "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": "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" } ] @@ -110398,6 +112192,13 @@ "isasync": false, "name": "listPaloAltoFirewalls", "params": [ + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + }, { "description": "", "length": 255, @@ -110414,11 +112215,11 @@ "type": "uuid" }, { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { "description": "the Physical Network ID", @@ -110427,35 +112228,23 @@ "related": "", "required": false, "type": "uuid" - }, - { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" } ], "related": "addPaloAltoFirewall", "response": [ { - "description": "device name", - "name": "fwdevicename", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "device capacity", + "name": "fwdevicecapacity", + "type": "long" }, { - "description": "the timeout (in seconds) for requests to the external firewall", - "name": "timeout", + "description": "the zone ID of the external firewall", + "name": "zoneid", "type": "string" }, { - "description": "the usage interface of the external firewall", - "name": "usageinterface", + "description": "device name", + "name": "fwdevicename", "type": "string" }, { @@ -110463,19 +112252,29 @@ "name": "jobstatus", "type": "integer" }, + { + "description": "device state", + "name": "fwdevicestate", + "type": "string" + }, + { + "description": "the public interface of the external firewall", + "name": "publicinterface", + "type": "string" + }, { "description": "name of the provider", "name": "provider", "type": "string" }, { - "description": "the zone ID of the external firewall", - "name": "zoneid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the username that's used to log in to the external firewall", - "name": "username", + "description": "the private interface of the external firewall", + "name": "privateinterface", "type": "string" }, { @@ -110484,30 +112283,30 @@ "type": "string" }, { - "description": "the private interface of the external firewall", - "name": "privateinterface", + "description": "the private security zone of the external firewall", + "name": "privatezone", "type": "string" }, {}, { - "description": "the private security zone of the external firewall", - "name": "privatezone", + "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": "fwdevicestate", + "description": "the public security zone of the external firewall", + "name": "publiczone", "type": "string" }, - {}, { - "description": "the public interface of the external firewall", - "name": "publicinterface", + "description": "the usage interface of the external firewall", + "name": "usageinterface", "type": "string" }, { @@ -110516,13 +112315,8 @@ "type": "string" }, { - "description": "device capacity", - "name": "fwdevicecapacity", - "type": "long" - }, - { - "description": "the public security zone of the external firewall", - "name": "publiczone", + "description": "the username that's used to log in to the external firewall", + "name": "username", "type": "string" }, { @@ -110537,21 +112331,6 @@ "isasync": true, "name": "updateLoadBalancerRule", "params": [ - { - "description": "the ID of the load balancer rule to update", - "length": 255, - "name": "id", - "related": "", - "required": true, - "type": "uuid" - }, - { - "description": "the description of the load balancer rule", - "length": 4096, - "name": "description", - "required": false, - "type": "string" - }, { "description": "The protocol for the LB", "length": 255, @@ -110568,12 +112347,20 @@ "type": "boolean" }, { - "description": "load balancer algorithm (source, roundrobin, leastconn)", - "length": 255, - "name": "algorithm", + "description": "the description of the load balancer rule", + "length": 4096, + "name": "description", "required": false, "type": "string" }, + { + "description": "the ID of the load balancer rule to update", + "length": 255, + "name": "id", + "related": "", + "required": true, + "type": "uuid" + }, { "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", "length": 255, @@ -110582,6 +112369,13 @@ "since": "4.4", "type": "string" }, + { + "description": "load balancer algorithm (source, roundrobin, leastconn)", + "length": 255, + "name": "algorithm", + "required": false, + "type": "string" + }, { "description": "the name of the load balancer rule", "length": 255, @@ -110593,74 +112387,48 @@ "related": "listLoadBalancerRules", "response": [ { - "description": "the load balancer rule ID", - "name": "id", - "type": "string" - }, - { - "description": "the name of the load balancer", - "name": "name", - "type": "string" - }, - { - "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", + "description": "the public ip address", + "name": "publicip", "type": "string" }, { - "description": "the domain of the load balancer rule", - "name": "domain", + "description": "the load balancer rule ID", + "name": "id", "type": "string" }, { - "description": "the public port", - "name": "publicport", + "description": "the public ip address id", + "name": "publicipid", "type": "string" }, { - "description": "the id of the guest network the lb rule belongs to", - "name": "networkid", + "description": "the project id of the load balancer", + "name": "projectid", "type": "string" }, { - "description": "the description of the load balancer", - "name": "description", + "description": "the project name of the load balancer", + "name": "project", "type": "string" }, { - "description": "the protocol of the loadbalanacer rule", - "name": "protocol", + "description": "the private port", + "name": "privateport", "type": "string" }, { - "description": "the project id of the load balancer", - "name": "projectid", + "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 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", - "type": "string" - }, - { - "description": "the project name of the load balancer", - "name": "project", - "type": "string" - }, { - "description": "the private port", - "name": "privateport", + "description": "the domain of the load balancer rule", + "name": "domain", "type": "string" }, { @@ -110668,13 +112436,18 @@ "name": "tags", "response": [ { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { @@ -110683,8 +112456,8 @@ "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { @@ -110693,23 +112466,18 @@ "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { @@ -110721,15 +112489,25 @@ "type": "list" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the id of the zone the rule belongs to", + "name": "zoneid", + "type": "string" }, { - "description": "the public ip address", - "name": "publicip", + "description": "the description of the load balancer", + "name": "description", + "type": "string" + }, + { + "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", + "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", @@ -110737,13 +112515,28 @@ }, {}, { - "description": "the public ip address id", - "name": "publicipid", + "description": "is rule for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, + { + "description": "the protocol of the loadbalanacer rule", + "name": "protocol", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the account of the load balancer rule", + "name": "account", + "type": "string" + }, + { + "description": "the public port", + "name": "publicport", + "type": "string" + }, + { + "description": "the name of the load balancer", + "name": "name", "type": "string" }, { @@ -110752,15 +112545,16 @@ "type": "string" }, { - "description": "the id of the zone the rule belongs to", - "name": "zoneid", + "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", + "description": "the name of the zone the load balancer rule belongs to", + "name": "zonename", "type": "string" - } + }, + {} ] }, { @@ -110775,14 +112569,6 @@ "required": false, "type": "date" }, - { - "description": "the IDs of the alerts", - "length": 255, - "name": "ids", - "related": "", - "required": false, - "type": "list" - }, { "description": "delete by alert type", "length": 255, @@ -110796,20 +112582,23 @@ "name": "startdate", "required": false, "type": "date" + }, + { + "description": "the IDs of the alerts", + "length": 255, + "name": "ids", + "related": "", + "required": false, + "type": "list" } ], "response": [ {}, - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - }, {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, { "description": "the UUID of the latest async job acting on this object", @@ -110817,9 +112606,14 @@ "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" } ] }, @@ -110855,99 +112649,78 @@ "related": "listAccounts", "response": [ { - "description": "the total number of projects the account can own", - "name": "projectlimit", + "description": "the total number of virtual machines available for this account to acquire", + "name": "vmavailable", "type": "string" }, { - "description": "path of the Domain the account belongs to", - "name": "domainpath", + "description": "the total number of cpu cores available to be created for this account", + "name": "cpuavailable", "type": "string" }, { - "description": "the total secondary storage space (in GiB) owned by account", - "name": "secondarystoragetotal", - "type": "float" + "description": "the total number of vpcs available to be created for this account", + "name": "vpcavailable", + "type": "string" }, { - "description": "the total number of cpu cores the account can own", - "name": "cpulimit", + "description": "the total number of public ip addresses available for this account to acquire", + "name": "ipavailable", "type": "string" }, { - "description": "the state of the account", - "name": "state", + "description": "the total number of projects the account can own", + "name": "projectlimit", "type": "string" }, - {}, { - "description": "the total secondary storage space (in GiB) the account can own", - "name": "secondarystoragelimit", + "description": "the total memory (in MB) the account can own", + "name": "memorylimit", "type": "string" }, { - "description": "the total number of virtual machines running for this account", - "name": "vmrunning", - "type": "integer" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the total volume being used by this account", - "name": "volumetotal", + "description": "the total number of virtual machines deployed by this account", + "name": "vmtotal", "type": "long" }, { - "description": "the list of acl groups that account belongs to", - "name": "groups", - "type": "list" - }, - { - "description": "the total number of networks owned by account", - "name": "networktotal", + "description": "the total number of snapshots stored by this account", + "name": "snapshottotal", "type": "long" }, - { - "description": "the id of the account", - "name": "id", - "type": "string" - }, { "description": "the total number of projects being administrated by this account", "name": "projecttotal", "type": "long" }, { - "description": "the total secondary storage space (in GiB) available to be used for this account", - "name": "secondarystorageavailable", - "type": "string" - }, - { - "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": "true if account is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "true if the account requires cleanup", + "name": "iscleanuprequired", + "type": "boolean" }, { - "description": "the total number of vpcs owned by account", - "name": "vpctotal", - "type": "long" + "description": "details for the account", + "name": "accountdetails", + "type": "map" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the total number of templates which can be created by this account", + "name": "templatelimit", + "type": "string" }, { - "description": "the total primary storage space (in GiB) owned by account", - "name": "primarystoragetotal", + "description": "the total memory (in MB) owned by account", + "name": "memorytotal", "type": "long" }, { @@ -110956,153 +112729,132 @@ "type": "string" }, { - "description": "true if account is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "the total number of networks the account can own", - "name": "networklimit", - "type": "string" - }, - { - "description": "the total volume which can be used by this account", - "name": "volumelimit", - "type": "string" - }, - { - "description": "the total number of cpu cores available to be created for this account", - "name": "cpuavailable", - "type": "string" - }, - { - "description": "the total primary storage space (in GiB) available to be used for this account", - "name": "primarystorageavailable", - "type": "string" + "description": "the total number of cpu cores owned by account", + "name": "cputotal", + "type": "long" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the total number of projects available for administration by this account", + "name": "projectavailable", "type": "string" }, - { - "description": "account type (admin, domain-admin, user)", - "name": "accounttype", - "type": "short" - }, { "description": "the total number of templates available to be created by this account", "name": "templateavailable", "type": "string" }, { - "description": "the total number of vpcs the account can own", - "name": "vpclimit", - "type": "string" + "description": "the total number of virtual machines stopped for this account", + "name": "vmstopped", + "type": "integer" }, { - "description": "id of the Domain the account belongs to", - "name": "domainid", + "description": "the total number of vpcs the account can own", + "name": "vpclimit", "type": "string" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" - }, - { - "description": "the total memory (in MB) the account can own", - "name": "memorylimit", + "description": "the network domain", + "name": "networkdomain", "type": "string" }, { - "description": "the total primary storage space (in GiB) the account can own", - "name": "primarystoragelimit", + "description": "the total memory (in MB) available to be created for this account", + "name": "memoryavailable", "type": "string" }, { - "description": "the total number of projects available for administration by this account", - "name": "projectavailable", + "description": "the default zone of the account", + "name": "defaultzoneid", "type": "string" }, { - "description": "the name of the account", - "name": "name", + "description": "the total number of snapshots available for this account", + "name": "snapshotavailable", "type": "string" }, { - "description": "the total number of virtual machines stopped for this account", - "name": "vmstopped", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": "the total memory (in MB) owned by account", - "name": "memorytotal", + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", "type": "long" }, { - "description": "the total number of vpcs available to be created for this account", - "name": "vpcavailable", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the total number of templates which can be created by this account", - "name": "templatelimit", + "description": "the total primary storage space (in GiB) available to be used for this account", + "name": "primarystorageavailable", "type": "string" }, { - "description": "the total number of public ip addresses this account can acquire", - "name": "iplimit", - "type": "string" + "description": "the total number of templates which have been created by this account", + "name": "templatetotal", + "type": "long" }, - {}, { - "description": "name of the Domain the account belongs to", - "name": "domain", + "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 available for this account to acquire", - "name": "ipavailable", + "description": "the total number of networks the account can own", + "name": "networklimit", "type": "string" }, { - "description": "the total number of virtual machines that can be deployed by this account", - "name": "vmlimit", + "description": "id of the Domain the account belongs to", + "name": "domainid", "type": "string" }, + { + "description": "the total number of virtual machines running for this account", + "name": "vmrunning", + "type": "integer" + }, { "description": "the list of users associated with account", "name": "user", "response": [ { - "description": "the secret key of the user", - "name": "secretkey", + "description": "the name of the role", + "name": "rolename", "type": "string" }, { - "description": "the domain ID of the user", - "name": "domainid", + "description": "the account ID of the user", + "name": "accountid", + "type": "string" + }, + { + "description": "the type of the role", + "name": "roletype", "type": "string" }, { "description": "the account type of the user", "name": "accounttype", - "type": "short" + "type": "integer" }, { - "description": "the user lastname", - "name": "lastname", + "description": "the secret key of the user", + "name": "secretkey", "type": "string" }, { - "description": "the user state", - "name": "state", - "type": "string" + "description": "the boolean value representing if the updating target is in caller's child domain", + "name": "iscallerchilddomain", + "type": "boolean" }, { - "description": "the api key of the user", - "name": "apikey", + "description": "the user name", + "name": "username", "type": "string" }, { @@ -111116,53 +112868,33 @@ "type": "string" }, { - "description": "the user firstname", - "name": "firstname", + "description": "the user ID", + "name": "id", "type": "string" }, { - "description": "the name of the role", - "name": "rolename", + "description": "the user firstname", + "name": "firstname", "type": "string" }, - { - "description": "the boolean value representing if the updating target is in caller's child domain", - "name": "iscallerchilddomain", - "type": "boolean" - }, { "description": "the user email address", "name": "email", "type": "string" }, { - "description": "the domain name of the user", - "name": "domain", - "type": "string" - }, - { - "description": "the user name", - "name": "username", + "description": "the domain ID of the user", + "name": "domainid", "type": "string" }, { - "description": "true if user is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "the account name of the user", - "name": "account", + "description": "the user state", + "name": "state", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "the user ID", - "name": "id", + "description": "the api key of the user", + "name": "apikey", "type": "string" }, { @@ -111171,8 +112903,13 @@ "type": "date" }, { - "description": "the type of the role", - "name": "roletype", + "description": "the account name of the user", + "name": "account", + "type": "string" + }, + { + "description": "the domain name of the user", + "name": "domain", "type": "string" }, { @@ -111181,76 +112918,123 @@ "type": "string" }, { - "description": "the account ID of the user", - "name": "accountid", + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the user lastname", + "name": "lastname", "type": "string" + }, + { + "description": "true if user is default, false otherwise", + "name": "isdefault", + "type": "boolean" } ], "type": "list" }, { - "description": "the name of the role", - "name": "rolename", - "type": "string" + "description": "the date when this account was created", + "name": "created", + "type": "date" }, { - "description": "the total number of templates which have been created by this account", - "name": "templatetotal", + "description": "account type (admin, domain-admin, user)", + "name": "accounttype", + "type": "integer" + }, + { + "description": "the total volume being used by this account", + "name": "volumetotal", "type": "long" }, + {}, { - "description": "the total number of virtual machines available for this account to acquire", - "name": "vmavailable", + "description": "the total number of cpu cores the account can own", + "name": "cpulimit", "type": "string" }, { - "description": "the total number of snapshots available for this account", - "name": "snapshotavailable", + "description": "the total number of snapshots which can be stored by this account", + "name": "snapshotlimit", "type": "string" }, { - "description": "details for the account", - "name": "accountdetails", - "type": "map" + "description": "the name of the account", + "name": "name", + "type": "string" }, + {}, { - "description": "the type of the role (Admin, ResourceAdmin, DomainAdmin, User)", - "name": "roletype", + "description": "the state of the account", + "name": "state", "type": "string" }, { - "description": "the total number of virtual machines deployed by this account", - "name": "vmtotal", - "type": "long" + "description": "name of the Domain the account belongs to", + "name": "domain", + "type": "string" }, { - "description": "the total number of snapshots stored by this account", - "name": "snapshottotal", + "description": "the id of the account", + "name": "id", + "type": "string" + }, + { + "description": "the total number of networks owned by account", + "name": "networktotal", "type": "long" }, { - "description": "the date when this account was created", - "name": "created", - "type": "date" + "description": "the total number of virtual machines that can be deployed by this account", + "name": "vmlimit", + "type": "string" }, { - "description": "true if the account requires cleanup", - "name": "iscleanuprequired", - "type": "boolean" + "description": "the 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", + "description": "path of the Domain the account belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the total number of networks available to be created for this account", - "name": "networkavailable", + "description": "the total volume which can be used by this account", + "name": "volumelimit", "type": "string" }, { - "description": "the default zone of the account", - "name": "defaultzoneid", + "description": "the total primary storage space (in GiB) owned by account", + "name": "primarystoragetotal", + "type": "long" + }, + { + "description": "the total secondary storage space (in GiB) the account can own", + "name": "secondarystoragelimit", + "type": "string" + }, + { + "description": "the name of the role", + "name": "rolename", + "type": "string" + }, + { + "description": "the total secondary storage space (in GiB) owned by account", + "name": "secondarystoragetotal", + "type": "float" + }, + { + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" + }, + { + "description": "the type of the role (Admin, ResourceAdmin, DomainAdmin, User)", + "name": "roletype", "type": "string" }, { @@ -111259,19 +113043,29 @@ "type": "string" }, { - "description": "the total number of cpu cores owned by account", - "name": "cputotal", - "type": "long" + "description": "the total number of public ip addresses this account can acquire", + "name": "iplimit", + "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", + "description": "the total secondary storage space (in GiB) available to be used for this account", + "name": "secondarystorageavailable", + "type": "string" + }, + { + "description": "the total number of public ip addresses allocated for this account", + "name": "iptotal", "type": "long" }, { - "description": "the network domain", - "name": "networkdomain", - "type": "string" + "description": "the total primary storage space (in GiB) the account can own", + "name": "primarystoragelimit", + "type": "string" + }, + { + "description": "the total number of vpcs owned by account", + "name": "vpctotal", + "type": "long" } ] }, @@ -111288,13 +113082,6 @@ "required": true, "type": "uuid" }, - { - "description": "parameters other than zoneId/serviceOfferringId/templateId of the auto deployed virtual machine", - "length": 255, - "name": "otherdeployparams", - "required": false, - "type": "string" - }, { "description": "the ID of the user used to launch and destroy the VMs", "length": 255, @@ -111303,6 +113090,14 @@ "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" + }, { "description": "the service offering of the auto deployed virtual machine", "length": 255, @@ -111312,11 +113107,12 @@ "type": "uuid" }, { - "description": "counterparam list. Example: counterparam[0].name=snmpcommunity&counterparam[0].value=public&counterparam[1].name=snmpport&counterparam[1].value=161", + "description": "an optional field, whether to the display the profile to the end user or not", "length": 255, - "name": "counterparam", + "name": "fordisplay", "required": false, - "type": "map" + "since": "4.4", + "type": "boolean" }, { "description": "the time allowed for existing connections to get closed before a vm is destroyed", @@ -111326,92 +113122,90 @@ "type": "integer" }, { - "description": "an optional field, whether to the display the profile to the end user or not", + "description": "counterparam list. Example: counterparam[0].name=snmpcommunity&counterparam[0].value=public&counterparam[1].name=snmpport&counterparam[1].value=161", "length": 255, - "name": "fordisplay", + "name": "counterparam", "required": false, - "since": "4.4", - "type": "boolean" + "type": "map" }, { - "description": "the template of the auto deployed virtual machine", + "description": "parameters other than zoneId/serviceOfferringId/templateId of the auto deployed virtual machine", "length": 255, - "name": "templateid", - "related": "listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", - "required": true, - "type": "uuid" + "name": "otherdeployparams", + "required": false, + "type": "string" } ], "related": "", "response": [ + {}, { - "description": "parameters other than zoneId/serviceOfferringId/templateId to be used while deploying a virtual machine", - "name": "otherdeployparams", - "type": "string" + "description": "is profile for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the autoscale vm profile ID", + "name": "id", "type": "string" }, { - "description": "the account owning the instance group", - "name": "account", + "description": "the domain ID of the vm profile", + "name": "domainid", "type": "string" }, {}, { - "description": "the availability zone to be used while deploying a virtual machine", - "name": "zoneid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {}, { - "description": "the project id vm profile", - "name": "projectid", + "description": "the service offering to be used while deploying a virtual machine", + "name": "serviceofferingid", "type": "string" }, { - "description": "the ID of the user used to launch and destroy the VMs", - "name": "autoscaleuserid", + "description": "the domain name of the vm profile", + "name": "domain", "type": "string" }, { - "description": "the domain ID of the vm profile", - "name": "domainid", + "description": "parameters other than zoneId/serviceOfferringId/templateId to be used while deploying a virtual machine", + "name": "otherdeployparams", "type": "string" }, + {}, { - "description": "the autoscale vm profile ID", - "name": "id", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, - {}, { - "description": "the domain name of the vm profile", - "name": "domain", - "type": "string" + "description": "the time allowed for existing connections to get closed before a vm is destroyed", + "name": "destroyvmgraceperiod", + "type": "integer" }, { - "description": "the project name of the vm profile", - "name": "project", + "description": "the availability zone to be used while deploying a virtual machine", + "name": "zoneid", "type": "string" }, + {}, { - "description": "the service offering to be used while deploying a virtual machine", - "name": "serviceofferingid", + "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 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": "destroyvmgraceperiod", - "type": "integer" + "description": "the project name of the vm profile", + "name": "project", + "type": "string" }, { "description": "the template to be used while deploying a virtual machine", @@ -111419,9 +113213,9 @@ "type": "string" }, { - "description": "is profile for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "the account owning the instance group", + "name": "account", + "type": "string" } ] }, @@ -111431,26 +113225,33 @@ "name": "listLBStickinessPolicies", "params": [ { - "description": "", + "description": "List by keyword", "length": 255, - "name": "pagesize", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" + }, + { + "description": "the ID of the load balancer rule", + "length": 255, + "name": "lbruleid", + "related": "", + "required": false, + "type": "uuid" }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, { - "description": "the ID of the load balancer stickiness policy", + "description": "", "length": 255, - "name": "id", - "related": "listLBStickinessPolicies", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" }, { "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", @@ -111461,32 +113262,24 @@ "type": "boolean" }, { - "description": "the ID of the load balancer rule", + "description": "the ID of the load balancer stickiness policy", "length": 255, - "name": "lbruleid", - "related": "", + "name": "id", + "related": "listLBStickinessPolicies", "required": false, "type": "uuid" - }, - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" } ], "related": "", "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": "the LB rule ID", - "name": "lbruleid", + "description": "the domain of the Stickiness policy", + "name": "domain", "type": "string" }, { @@ -111495,50 +113288,46 @@ "type": "string" }, { - "description": "the id of the zone the Stickiness policy belongs to", - "name": "zoneid", + "description": "the domain ID of the Stickiness policy", + "name": "domainid", "type": "string" }, {}, + { + "description": "the LB rule ID", + "name": "lbruleid", + "type": "string" + }, + { + "description": "the description of the Stickiness policy", + "name": "description", + "type": "string" + }, { "description": "the name of the Stickiness policy", "name": "name", "type": "string" }, { - "description": "the domain of the Stickiness policy", - "name": "domain", + "description": "the id of the zone the Stickiness policy belongs to", + "name": "zoneid", "type": "string" }, + {}, { "description": "the state of the policy", "name": "state", "type": "string" }, { - "description": "the domain ID of the Stickiness policy", - "name": "domainid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "the list of stickinesspolicies", "name": "stickinesspolicy", "response": [ - { - "description": "the state of the policy", - "name": "state", - "type": "string" - }, - { - "description": "the name of the Stickiness policy", - "name": "name", - "type": "string" - }, { "description": "is policy for display to the regular user", "name": "fordisplay", @@ -111549,11 +113338,6 @@ "name": "methodname", "type": "string" }, - { - "description": "the description of the Stickiness policy", - "name": "description", - "type": "string" - }, { "description": "the params of the policy", "name": "params", @@ -111563,14 +113347,24 @@ "description": "the LB Stickiness policy ID", "name": "id", "type": "string" + }, + { + "description": "the name of the Stickiness policy", + "name": "name", + "type": "string" + }, + { + "description": "the description of the Stickiness policy", + "name": "description", + "type": "string" + }, + { + "description": "the state of the policy", + "name": "state", + "type": "string" } ], "type": "list" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" } ], "since": "3.0.0" @@ -111581,26 +113375,26 @@ "name": "addUcsManager", "params": [ { - "description": "the name of UCS manager", + "description": "the name of UCS url", "length": 255, - "name": "name", - "required": false, + "name": "url", + "required": true, "type": "string" }, { - "description": "the Zone id for the ucs manager", + "description": "the username of UCS", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "username", "required": true, - "type": "uuid" + "type": "string" }, { - "description": "the name of UCS url", + "description": "the Zone id for the ucs manager", "length": 255, - "name": "url", + "name": "zoneid", + "related": "listZones", "required": true, - "type": "string" + "type": "uuid" }, { "description": "the password of UCS", @@ -111610,19 +113404,23 @@ "type": "string" }, { - "description": "the username of UCS", + "description": "the name of UCS manager", "length": 255, - "name": "username", - "required": true, + "name": "name", + "required": false, "type": "string" } ], "related": "", "response": [ - {}, { - "description": "the url of ucs manager", - "name": "url", + "description": "the zone ID of ucs manager", + "name": "zoneid", + "type": "string" + }, + { + "description": "the name of ucs manager", + "name": "name", "type": "string" }, { @@ -111630,20 +113428,16 @@ "name": "id", "type": "string" }, + {}, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the zone ID of ucs manager", - "name": "zoneid", - "type": "string" - }, - {}, - { - "description": "the name of ucs manager", - "name": "name", + "description": "the url of ucs manager", + "name": "url", "type": "string" }, { @@ -111658,13 +113452,6 @@ "isasync": true, "name": "deleteNetwork", "params": [ - { - "description": "Force delete a network. Network will be marked as 'Destroy' even when commands to shutdown and cleanup to the backend fails.", - "length": 255, - "name": "forced", - "required": false, - "type": "boolean" - }, { "description": "the ID of the network", "length": 255, @@ -111672,9 +113459,22 @@ "related": "createNetwork,updateNetwork,listNetworks", "required": true, "type": "uuid" + }, + { + "description": "Force delete a network. Network will be marked as 'Destroy' even when commands to shutdown and cleanup to the backend fails.", + "length": 255, + "name": "forced", + "required": false, + "type": "boolean" } ], "response": [ + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + {}, {}, { "description": "any text associated with the success or failure", @@ -111686,12 +113486,6 @@ "name": "jobstatus", "type": "integer" }, - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, { "description": "true if operation is executed successfully", "name": "success", @@ -111708,7 +113502,7 @@ "description": "the host ID", "length": 255, "name": "id", - "related": "reconnectHost,addBaremetalHost", + "related": "addBaremetalHost,reconnectHost", "required": true, "type": "uuid" } @@ -111716,34 +113510,40 @@ "related": "addBaremetalHost", "response": [ { - "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise", - "name": "hahost", - "type": "boolean" + "description": "the Pod name of the host", + "name": "podname", + "type": "string" }, { - "description": "the last time this host was annotated", - "name": "lastannotated", - "type": "date" + "description": "the management server ID of the host", + "name": "managementserverid", + "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the resource state of the host", + "name": "resourcestate", + "type": "string" }, { - "description": "the name of the host", - "name": "name", + "description": "true if the host is disconnected. False otherwise.", + "name": "disconnected", + "type": "date" + }, + {}, + { + "description": "the cluster ID of the host", + "name": "clusterid", "type": "string" }, { - "description": "the amount of the host's CPU currently allocated in MHz", - "name": "cpuallocatedvalue", + "description": "the total disk size of the host", + "name": "disksizetotal", "type": "long" }, { - "description": "the Zone name of the host", - "name": "zonename", - "type": "string" + "description": "the date and time the host was removed", + "name": "removed", + "type": "date" }, { "description": "true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise", @@ -111751,124 +113551,170 @@ "type": "boolean" }, { - "description": "true if local storage is active, false otherwise", - "name": "islocalstorageactive", - "type": "boolean" + "description": "the date and time the host was created", + "name": "created", + "type": "date" }, { - "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", - "name": "memorytotal", + "description": "the amount of the host's memory currently allocated", + "name": "memoryallocated", "type": "long" }, { - "description": "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", + "type": "string" }, { - "description": "the outgoing network traffic on the host", - "name": "networkkbswrite", - "type": "long" + "description": "the host type", + "name": "type", + "type": "type" }, { - "description": "the amount of the host's memory currently used", - "name": "memoryused", - "type": "long" + "description": "the IP address of the host", + "name": "ipaddress", + "type": "string" }, { - "description": "the ID of the host", - "name": "id", - "type": "string" + "description": "the CPU number of the host", + "name": "cpunumber", + "type": "integer" }, { - "description": "the OS category name of the host", - "name": "oscategoryname", + "description": "the host version", + "name": "version", "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": "the host version", - "name": "version", + "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor", + "name": "cpuwithoverprovisioning", "type": "string" }, { - "description": "the Zone ID of the host", - "name": "zoneid", + "description": "the Zone name of the host", + "name": "zonename", "type": "string" }, { - "description": "the host type", - "name": "type", - "type": "type" + "description": "the cluster name of the host", + "name": "clustername", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the host's currently allocated disk size", + "name": "disksizeallocated", + "type": "long" }, { - "description": "the amount of the host's memory currently allocated", - "name": "memoryallocated", + "description": "the amount of the host's CPU currently allocated in MHz", + "name": "cpuallocatedvalue", "type": "long" }, { - "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", - "name": "cpuallocatedwithoverprovisioning", + "description": "the name of the host", + "name": "name", "type": "string" }, + {}, { - "description": "the CPU number of the host", - "name": "cpunumber", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": "the amount of the host's memory currently allocated in bytes", - "name": "memoryallocatedbytes", + "description": "the cpu average load on the host", + "name": "cpuloadaverage", + "type": "double" + }, + { + "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", + "name": "memorytotal", "type": "long" }, { - "description": "the cluster type of the cluster that host belongs to", - "name": "clustertype", + "description": "the host hypervisor", + "name": "hypervisor", + "type": "hypervisortype" + }, + { + "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 amount of the host's CPU currently allocated", + "name": "cpuallocated", + "type": "string" }, { - "description": "the date and time the host was removed", - "name": "removed", - "type": "date" + "description": "the ID of the host", + "name": "id", + "type": "string" }, { - "description": "the resource state of the host", - "name": "resourcestate", + "description": "comma-separated list of tags for the host", + "name": "hosttags", "type": "string" }, + { + "description": "the amount of the host's memory currently used", + "name": "memoryused", + "type": "long" + }, { "description": "the host HA information information", "name": "hostha", "type": "hostharesponse" }, + { + "description": "the number of CPU sockets on the host", + "name": "cpusockets", + "type": "integer" + }, { "description": "the amount of the host's CPU currently allocated in percentage", "name": "cpuallocatedpercentage", "type": "string" }, { - "description": "the amount of the host's memory currently allocated in percentage", - "name": "memoryallocatedpercentage", + "description": "the admin that annotated this host", + "name": "username", "type": "string" }, { - "description": "the last annotation set on this host by an admin", - "name": "annotation", - "type": "string" + "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise", + "name": "hahost", + "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 outgoing network traffic on the host", + "name": "networkkbswrite", + "type": "long" + }, + { + "description": "the CPU speed of the host", + "name": "cpuspeed", + "type": "long" + }, + { + "description": "true if the host has capability to support UEFI boot", + "name": "ueficapability", + "type": "boolean" + }, + { + "description": "Host details in key/value pairs.", + "name": "details", + "type": "map" }, { "description": "the state of the host", @@ -111876,103 +113722,81 @@ "type": "status" }, { - "description": "the amount of the host's memory after applying the mem.overprovisioning.factor", - "name": "memorywithoverprovisioning", + "description": "the OS category ID of the host", + "name": "oscategoryid", "type": "string" }, { - "description": "capabilities of the host", - "name": "capabilities", + "description": "the cluster type of the cluster that host belongs to", + "name": "clustertype", "type": "string" }, { - "description": "the number of CPU sockets on the host", - "name": "cpusockets", - "type": "integer" - }, - { - "description": "the date and time the host was last pinged", - "name": "lastpinged", - "type": "date" - }, - { - "description": "the management server ID of the host", - "name": "managementserverid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "comma-separated list of tags for the host", - "name": "hosttags", + "description": "the Zone ID of the host", + "name": "zoneid", "type": "string" }, { - "description": "the date and time the host was created", - "name": "created", - "type": "date" + "description": "the Pod ID of the host", + "name": "podid", + "type": "string" }, { "description": "the incoming network traffic on the host", "name": "networkkbsread", "type": "long" }, - {}, { - "description": "the amount of the host's CPU currently allocated", - "name": "cpuallocated", - "type": "string" + "description": "the host out-of-band management information", + "name": "outofbandmanagement", + "type": "outofbandmanagementresponse" }, { - "description": "events available for the host", - "name": "events", + "description": "the hypervisor version", + "name": "hypervisorversion", "type": "string" }, - {}, { - "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 cluster name of the host", - "name": "clustername", + "description": "capabilities of the host", + "name": "capabilities", "type": "string" }, { - "description": "the OS category ID of the host", - "name": "oscategoryid", - "type": "string" + "description": "the amount of the host's memory currently allocated in bytes", + "name": "memoryallocatedbytes", + "type": "long" }, { "description": "GPU cards present in the host", "name": "gpugroup", "response": [ - { - "description": "GPU cards present in the host", - "name": "gpugroupname", - "type": "string" - }, { "description": "the list of enabled vGPUs", "name": "vgpu", "response": [ - { - "description": "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": "Video RAM for this vGPU type", - "name": "videoram", + "description": "Model Name of vGPU", + "name": "vgputype", + "type": "string" + }, + { + "description": "Maximum no. of vgpu per gpu card (pgpu)", + "name": "maxvgpuperpgpu", "type": "long" }, { @@ -111986,94 +113810,64 @@ "type": "long" }, { - "description": "Maximum no. of vgpu per gpu card (pgpu)", - "name": "maxvgpuperpgpu", + "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" } ], "type": "list" + }, + { + "description": "GPU cards present in the host", + "name": "gpugroupname", + "type": "string" } ], "type": "list" }, { - "description": "true if the host is disconnected. False otherwise.", - "name": "disconnected", - "type": "date" - }, - { - "description": "the cpu average load on the host", - "name": "cpuloadaverage", - "type": "double" - }, - { - "description": "the IP address of the host", - "name": "ipaddress", + "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", + "name": "cpuallocatedwithoverprovisioning", "type": "string" }, { - "description": "the Pod ID of the host", - "name": "podid", + "description": "the OS category name of the host", + "name": "oscategoryname", "type": "string" }, { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", - "type": "long" - }, - { - "description": "the hypervisor version", - "name": "hypervisorversion", - "type": "string" + "description": "the last time this host was annotated", + "name": "lastannotated", + "type": "date" }, { - "description": "true if the host has capability to support UEFI boot", - "name": "ueficapability", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "the total disk size of the host", - "name": "disksizetotal", - "type": "long" - }, - { - "description": "the admin that annotated this host", - "name": "username", - "type": "string" - }, - { - "description": "the amount of the host's CPU currently used", - "name": "cpuused", - "type": "string" - }, - { - "description": "the host out-of-band management information", - "name": "outofbandmanagement", - "type": "outofbandmanagementresponse" - }, - { - "description": "the cluster ID of the host", - "name": "clusterid", - "type": "string" - }, - { - "description": "the host hypervisor", - "name": "hypervisor", - "type": "hypervisortype" + "description": "the date and time the host was last pinged", + "name": "lastpinged", + "type": "date" }, { - "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor", - "name": "cpuwithoverprovisioning", + "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", + "description": "the last annotation set on this host by an admin", + "name": "annotation", "type": "string" } ] @@ -112095,79 +113889,65 @@ "related": "", "response": [ { - "description": "the list of virtualmachine associated with this Kubernetes cluster", - "name": "virtualmachines", - "type": "list" - }, - { - "description": "the name of the Kubernetes cluster", - "name": "name", + "description": "the ID of the service offering of the Kubernetes cluster", + "name": "serviceofferingid", "type": "string" }, + {}, { - "description": "URL end point for the Kubernetes cluster dashboard UI", - "name": "consoleendpoint", - "type": "string" + "description": "Maximum size of the cluster", + "name": "maxsize", + "type": "long" }, { - "description": "the name of the network of the Kubernetes cluster", - "name": "associatednetworkname", + "description": "the cpu cores of the Kubernetes cluster", + "name": "cpunumber", "type": "string" }, { - "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 version for the Kubernetes cluster", - "name": "kubernetesversionname", + "description": "Public IP Address of the cluster", + "name": "ipaddress", "type": "string" }, { - "description": "the ID of the service offering of the Kubernetes cluster", - "name": "serviceofferingid", + "description": "the id of the Kubernetes cluster", + "name": "id", "type": "string" }, { - "description": "the control nodes count for the Kubernetes cluster", - "name": "controlnodes", - "type": "long" - }, - { - "description": "the ID of the network of the Kubernetes cluster", - "name": "networkid", + "description": "the name of the zone of the Kubernetes cluster", + "name": "zonename", "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", + "description": "the memory the Kubernetes cluster", + "name": "memory", "type": "string" }, { - "description": "the name of the zone of the Kubernetes cluster", - "name": "zoneid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the name of the service offering of the Kubernetes cluster", - "name": "serviceofferingname", + "description": "the project id of the Kubernetes cluster", + "name": "projectid", "type": "string" }, { - "description": "the name of the zone of the Kubernetes cluster", - "name": "zonename", + "description": "the ID of the network of the Kubernetes cluster", + "name": "networkid", "type": "string" }, { - "description": "Minimum size of the cluster", - "name": "minsize", - "type": "long" + "description": "the account associated with the Kubernetes cluster", + "name": "account", + "type": "string" }, { "description": "keypair details", @@ -112175,14 +113955,14 @@ "type": "string" }, { - "description": "the cpu cores of the Kubernetes cluster", - "name": "cpunumber", + "description": "URL end point for the Kubernetes cluster", + "name": "endpoint", "type": "string" }, { - "description": "the project name of the Kubernetes cluster", - "name": "project", - "type": "string" + "description": "the control nodes count for the Kubernetes cluster", + "name": "controlnodes", + "type": "long" }, { "description": "the master nodes count for the Kubernetes cluster. This parameter is deprecated, please use 'controlnodes' parameter.", @@ -112190,44 +113970,58 @@ "type": "long" }, { - "description": "URL end point for the Kubernetes cluster", - "name": "endpoint", + "description": "URL end point for the Kubernetes cluster dashboard UI", + "name": "consoleendpoint", "type": "string" }, { - "description": "the account associated with the Kubernetes cluster", - "name": "account", + "description": "the name of the Kubernetes cluster", + "name": "name", "type": "string" }, { - "description": "the description of the Kubernetes cluster", - "name": "description", + "description": "the project name of the Kubernetes cluster", + "name": "project", "type": "string" }, { - "description": "Public IP Address ID of the cluster", - "name": "ipaddressid", + "description": "the name of the zone of the Kubernetes cluster", + "name": "zoneid", "type": "string" }, { - "description": "the id of the Kubernetes cluster", - "name": "id", + "description": "the name of the Kubernetes version for the Kubernetes cluster", + "name": "kubernetesversionname", "type": "string" }, - {}, { "description": "the ID of the Kubernetes version for the Kubernetes cluster", "name": "kubernetesversionid", "type": "string" }, { - "description": "the project id of the Kubernetes cluster", - "name": "projectid", + "description": "the date when this Kubernetes cluster was created", + "name": "created", + "type": "date" + }, + { + "description": "the name of the network of the Kubernetes cluster", + "name": "associatednetworkname", "type": "string" }, { - "description": "the memory the Kubernetes cluster", - "name": "memory", + "description": "Minimum size of the cluster", + "name": "minsize", + "type": "long" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the name of the service offering of the Kubernetes cluster", + "name": "serviceofferingname", "type": "string" }, { @@ -112236,36 +114030,41 @@ "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "Whether autoscaling is enabled for the cluster", + "name": "autoscalingenabled", "type": "boolean" }, - { - "description": "Public IP Address of the cluster", - "name": "ipaddress", - "type": "string" - }, { "description": "the size (worker nodes count) of the Kubernetes cluster", "name": "size", "type": "long" }, - {}, + { + "description": "the state of the Kubernetes cluster", + "name": "state", + "type": "string" + }, + { + "description": "Public IP Address ID of the cluster", + "name": "ipaddressid", + "type": "string" + }, { "description": "the 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 list of virtualmachine associated with this Kubernetes cluster", + "name": "virtualmachines", + "type": "list" }, { - "description": "the state of the Kubernetes cluster", - "name": "state", + "description": "the description of the Kubernetes cluster", + "name": "description", "type": "string" }, + {}, { "description": "the ID of the template of the Kubernetes cluster", "name": "templateid", @@ -112296,16 +114095,7 @@ } ], "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", @@ -112317,7 +114107,16 @@ "name": "jobid", "type": "string" }, - {} + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + } ], "since": "3.0.0" }, @@ -112326,10 +114125,18 @@ "isasync": false, "name": "listNetscalerLoadBalancers", "params": [ + { + "description": "netscaler load balancer device ID", + "length": 255, + "name": "lbdeviceid", + "related": "addNetscalerLoadBalancer,listNetscalerLoadBalancers", + "required": false, + "type": "uuid" + }, { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, @@ -112342,12 +114149,11 @@ "type": "uuid" }, { - "description": "netscaler load balancer device ID", + "description": "", "length": 255, - "name": "lbdeviceid", - "related": "addNetscalerLoadBalancer,listNetscalerLoadBalancers", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" }, { "description": "List by keyword", @@ -112355,36 +114161,18 @@ "name": "keyword", "required": false, "type": "string" - }, - { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" } ], "related": "addNetscalerLoadBalancer", "response": [ { - "description": "public IP of the NetScaler representing GSLB site", - "name": "gslbproviderpublicip", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "device id of the netscaler load balancer", - "name": "lbdeviceid", - "type": "string" + "description": "true if NetScaler device is provisioned to be a GSLB service provider", + "name": "gslbprovider", + "type": "boolean" }, - {}, { - "description": "device name", - "name": "lbdevicename", + "description": "the public interface of the load balancer", + "name": "publicinterface", "type": "string" }, { @@ -112392,19 +114180,34 @@ "name": "lbdevicestate", "type": "string" }, + { + "description": "device capacity", + "name": "lbdevicecapacity", + "type": "long" + }, { "description": "true if device is dedicated for an account", "name": "lbdevicededicated", "type": "boolean" }, { - "description": "device capacity", - "name": "lbdevicecapacity", - "type": "long" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the management IP address of the external load balancer", - "name": "ipaddress", + "description": "true if NetScaler device is provisioned exclusively to be a GSLB service provider", + "name": "isexclusivegslbprovider", + "type": "boolean" + }, + { + "description": "private IP of the NetScaler representing GSLB site", + "name": "gslbproviderprivateip", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -112413,13 +114216,8 @@ "type": "list" }, { - "description": "true if NetScaler device is provisioned to be a GSLB service provider", - "name": "gslbprovider", - "type": "boolean" - }, - { - "description": "private IP of the NetScaler representing GSLB site", - "name": "gslbproviderprivateip", + "description": "public IP of the NetScaler representing GSLB site", + "name": "gslbproviderpublicip", "type": "string" }, { @@ -112428,30 +114226,31 @@ "type": "string" }, { - "description": "the physical network to which this netscaler device belongs to", - "name": "physicalnetworkid", + "description": "device name", + "name": "lbdevicename", "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": "the management IP address of the external load balancer", + "name": "ipaddress", + "type": "string" }, {}, { - "description": "the public interface of the load balancer", - "name": "publicinterface", + "description": "device id of the netscaler load balancer", + "name": "lbdeviceid", "type": "string" }, { - "description": "true if NetScaler device is provisioned exclusively to be a GSLB service provider", - "name": "isexclusivegslbprovider", - "type": "boolean" + "description": "the physical network to which this netscaler device belongs to", + "name": "physicalnetworkid", + "type": "string" } ] }, @@ -112461,32 +114260,32 @@ "name": "createInstanceGroup", "params": [ { - "description": "The project of the instance group", + "description": "the domain ID of account owning the instance group", "length": 255, - "name": "projectid", - "related": "", + "name": "domainid", + "related": "listDomains", "required": false, "type": "uuid" }, { - "description": "the account of the instance group. The account parameter must be used with the domainId parameter.", + "description": "the name of the instance group", "length": 255, - "name": "account", - "required": false, + "name": "name", + "required": true, "type": "string" }, { - "description": "the name of the instance group", + "description": "the account of the instance group. The account parameter must be used with the domainId parameter.", "length": 255, - "name": "name", - "required": true, + "name": "account", + "required": false, "type": "string" }, { - "description": "the domain ID of account owning the instance group", + "description": "The project of the instance group", "length": 255, - "name": "domainid", - "related": "listDomains", + "name": "projectid", + "related": "", "required": false, "type": "uuid" } @@ -112494,14 +114293,8 @@ "related": "", "response": [ { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - {}, - { - "description": "the domain name of the instance group", - "name": "domain", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -112510,45 +114303,51 @@ "type": "boolean" }, { - "description": "the project ID of the instance group", - "name": "projectid", + "description": "the domain name of the instance group", + "name": "domain", "type": "string" }, { - "description": "the account owning the instance group", - "name": "account", + "description": "the domain ID of the instance group", + "name": "domainid", "type": "string" }, + {}, + {}, { - "description": "the project name of the instance group", - "name": "project", + "description": "the ID of the instance group", + "name": "id", "type": "string" }, { - "description": "the ID of the instance group", - "name": "id", + "description": "the project name of the instance group", + "name": "project", "type": "string" }, { - "description": "time and date the instance group was created", - "name": "created", - "type": "date" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the 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 domain ID of the instance group", - "name": "domainid", + "description": "the account owning the instance group", + "name": "account", "type": "string" }, { "description": "the name of the instance group", "name": "name", "type": "string" + }, + { + "description": "time and date the instance group was created", + "name": "created", + "type": "date" } ] }, @@ -112569,41 +114368,41 @@ "related": "listTemplatePermissions,listIsoPermissions", "response": [ { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the template ID", + "name": "id", + "type": "string" }, {}, {}, { - "description": "the ID of the domain to which the template belongs", - "name": "domainid", - "type": "string" + "description": "true if this template is a public template, false otherwise", + "name": "ispublic", + "type": "boolean" }, { - "description": "the list of accounts the template is available for", - "name": "account", + "description": "the list of projects the template is available for", + "name": "projectids", "type": "list" }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "the template ID", - "name": "id", + "description": "the ID of the domain to which the template belongs", + "name": "domainid", "type": "string" }, { - "description": "the list of projects the template is available for", - "name": "projectids", + "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" } ] }, @@ -112613,17 +114412,24 @@ "name": "addNetscalerLoadBalancer", "params": [ { - "description": "private IP of the site", + "description": "true if NetScaler device being added is for providing GSLB service", "length": 255, - "name": "gslbproviderprivateip", + "name": "gslbprovider", "required": false, + "type": "boolean" + }, + { + "description": "Netscaler device type supports NetscalerMPXLoadBalancer, NetscalerVPXLoadBalancer, NetscalerSDXLoadBalancer", + "length": 255, + "name": "networkdevicetype", + "required": true, "type": "string" }, { - "description": "public IP of the site", + "description": "URL of the netscaler load balancer appliance.", "length": 255, - "name": "gslbproviderpublicip", - "required": false, + "name": "url", + "required": true, "type": "string" }, { @@ -112640,6 +114446,13 @@ "required": true, "type": "string" }, + { + "description": "public IP of the site", + "length": 255, + "name": "gslbproviderpublicip", + "required": false, + "type": "string" + }, { "description": "the Physical Network ID", "length": 255, @@ -112649,10 +114462,10 @@ "type": "uuid" }, { - "description": "Netscaler device type supports NetscalerMPXLoadBalancer, NetscalerVPXLoadBalancer, NetscalerSDXLoadBalancer", + "description": "private IP of the site", "length": 255, - "name": "networkdevicetype", - "required": true, + "name": "gslbproviderprivateip", + "required": false, "type": "string" }, { @@ -112661,109 +114474,95 @@ "name": "username", "required": true, "type": "string" - }, - { - "description": "URL of the netscaler load balancer appliance.", - "length": 255, - "name": "url", - "required": true, - "type": "string" - }, - { - "description": "true if NetScaler device being added is for providing GSLB service", - "length": 255, - "name": "gslbprovider", - "required": false, - "type": "boolean" } ], "related": "", "response": [ { - "description": "true if device is dedicated for an account", - "name": "lbdevicededicated", + "description": "true if NetScaler device is provisioned to be a GSLB service provider", + "name": "gslbprovider", "type": "boolean" }, { - "description": "name of the provider", - "name": "provider", - "type": "string" + "description": "true if NetScaler device is provisioned exclusively to be a GSLB service provider", + "name": "isexclusivegslbprovider", + "type": "boolean" }, - {}, { - "description": "device name", - "name": "lbdevicename", + "description": "device id of the netscaler load balancer", + "name": "lbdeviceid", "type": "string" }, { - "description": "device capacity", - "name": "lbdevicecapacity", - "type": "long" + "description": "device state", + "name": "lbdevicestate", + "type": "string" }, - {}, { - "description": "true if NetScaler device is provisioned exclusively to be a GSLB service provider", - "name": "isexclusivegslbprovider", - "type": "boolean" + "description": "the private interface of the load balancer", + "name": "privateinterface", + "type": "string" }, + {}, { - "description": "private IP of the NetScaler representing GSLB site", - "name": "gslbproviderprivateip", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the public interface of the load balancer", - "name": "publicinterface", + "description": "name of the provider", + "name": "provider", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "device capacity", + "name": "lbdevicecapacity", + "type": "long" }, { - "description": "the management IP address of the external load balancer", - "name": "ipaddress", + "description": "private IP of the NetScaler representing GSLB site", + "name": "gslbproviderprivateip", "type": "string" }, { - "description": "device state", - "name": "lbdevicestate", - "type": "string" + "description": "Used when NetScaler device is provider of EIP service. This parameter represents the list of pod's, for which there exists a policy based route on datacenter L3 router to route pod's subnet IP to a NetScaler device.", + "name": "podids", + "type": "list" }, { - "description": "public IP of the NetScaler representing GSLB site", - "name": "gslbproviderpublicip", + "description": "the physical network to which this netscaler device belongs to", + "name": "physicalnetworkid", "type": "string" }, { - "description": "the physical network to which this netscaler device belongs to", - "name": "physicalnetworkid", + "description": "the management IP address of the external load balancer", + "name": "ipaddress", "type": "string" }, + {}, { - "description": "device id of the netscaler load balancer", - "name": "lbdeviceid", + "description": "the public interface of the load balancer", + "name": "publicinterface", "type": "string" }, { - "description": "true if NetScaler device is provisioned to be a GSLB service provider", - "name": "gslbprovider", - "type": "boolean" + "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": "true if device is dedicated for an account", + "name": "lbdevicededicated", + "type": "boolean" }, { - "description": "the private interface of the load balancer", - "name": "privateinterface", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "public IP of the NetScaler representing GSLB site", + "name": "gslbproviderpublicip", "type": "string" } ] @@ -112773,13 +114572,6 @@ "isasync": true, "name": "createLoadBalancer", "params": [ - { - "description": "name of the load balancer", - "length": 255, - "name": "name", - "required": true, - "type": "string" - }, { "description": "the network id of the source ip address", "length": 255, @@ -112789,25 +114581,31 @@ "type": "uuid" }, { - "description": "an optional field, whether to the display the rule to the end user or not", + "description": "load balancer algorithm (source, roundrobin, leastconn)", "length": 255, - "name": "fordisplay", - "required": false, - "since": "4.4", - "type": "boolean" + "name": "algorithm", + "required": true, + "type": "string" }, { - "description": "the source IP address the network traffic will be load balanced from", + "description": "name of the load balancer", "length": 255, - "name": "sourceipaddress", - "required": false, + "name": "name", + "required": true, "type": "string" }, { - "description": "the load balancer scheme. Supported value in this release is Internal", + "description": "the TCP port of the virtual machine where the network traffic will be load balanced to", "length": 255, - "name": "scheme", + "name": "instanceport", "required": true, + "type": "integer" + }, + { + "description": "the source IP address the network traffic will be load balanced from", + "length": 255, + "name": "sourceipaddress", + "required": false, "type": "string" }, { @@ -112817,13 +114615,6 @@ "required": true, "type": "integer" }, - { - "description": "the description of the load balancer", - "length": 4096, - "name": "description", - "required": false, - "type": "string" - }, { "description": "The guest network the load balancer will be created for", "length": 255, @@ -112833,36 +114624,34 @@ "type": "uuid" }, { - "description": "the TCP port of the virtual machine where the network traffic will be load balanced to", + "description": "the load balancer scheme. Supported value in this release is Internal", "length": 255, - "name": "instanceport", + "name": "scheme", "required": true, - "type": "integer" + "type": "string" }, { - "description": "load balancer algorithm (source, roundrobin, leastconn)", - "length": 255, - "name": "algorithm", - "required": true, + "description": "the description of the load balancer", + "length": 4096, + "name": "description", + "required": false, "type": "string" + }, + { + "description": "an optional field, whether to the display the rule to the end user or not", + "length": 255, + "name": "fordisplay", + "required": false, + "since": "4.4", + "type": "boolean" } ], "related": "", "response": [ { - "description": "Load Balancer source ip network id", - "name": "sourceipaddressnetworkid", - "type": "string" - }, - { - "description": "the Load Balancer ID", - "name": "id", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "Load Balancer source ip", @@ -112870,69 +114659,22 @@ "type": "string" }, { - "description": "the domain ID of the Load Balancer", - "name": "domainid", - "type": "string" - }, - { - "description": "the account of the Load Balancer", - "name": "account", - "type": "string" - }, - { - "description": "the load balancer algorithm (source, roundrobin, leastconn)", - "name": "algorithm", - "type": "string" - }, - { - "description": "the name of the Load Balancer", - "name": "name", - "type": "string" - }, - { - "description": "the project id of the Load Balancer", - "name": "projectid", - "type": "string" - }, - { - "description": "the list of instances associated with the Load Balancer", - "name": "loadbalancerinstance", + "description": "the list of resource tags associated with the Load Balancer", + "name": "tags", "response": [ { - "description": "the state of the instance", - "name": "state", - "type": "string" - }, - { - "description": "the ip address of the instance", - "name": "ipaddress", - "type": "string" - }, - { - "description": "the name of the instance", - "name": "name", + "description": "tag key name", + "name": "key", "type": "string" }, - { - "description": "the instance ID", - "name": "id", - "type": "string" - } - ], - "type": "list" - }, - { - "description": "the list of resource tags associated with the Load Balancer", - "name": "tags", - "response": [ { "description": "the project id the tag belongs to", "name": "projectid", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { @@ -112941,8 +114683,8 @@ "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { @@ -112951,23 +114693,18 @@ "type": "string" }, { - "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": "id of the resource", - "name": "resourceid", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { @@ -112979,14 +114716,19 @@ "type": "list" }, { - "description": "the description of the Load Balancer", - "name": "description", + "description": "the domain of the Load Balancer", + "name": "domain", "type": "string" }, { "description": "the list of rules associated with the Load Balancer", "name": "loadbalancerrule", "response": [ + { + "description": "the state of the load balancer rule", + "name": "state", + "type": "string" + }, { "description": "source port of the load balancer rule", "name": "sourceport", @@ -112996,317 +114738,170 @@ "description": "instance port of the load balancer rule", "name": "instanceport", "type": "integer" - }, - { - "description": "the state of the load balancer rule", - "name": "state", - "type": "string" } ], "type": "list" }, - { - "description": "the domain of the Load Balancer", - "name": "domain", - "type": "string" - }, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "Load Balancer network id", - "name": "networkid", - "type": "string" - }, - { - "description": "the project name of the Load Balancer", - "name": "project", - "type": "string" - }, { "description": "is rule for display to the regular user", "name": "fordisplay", "type": "boolean" }, - {} - ], - "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 current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "name of the VM", - "name": "virtualmachinename", - "type": "string" - }, - { - "description": "ID of the VM", - "name": "virtualmachineid", - "type": "string" - }, - {}, - { - "description": "the interval type of the backup schedule", - "name": "intervaltype", - "type": "intervaltype" - }, - {}, - { - "description": "time the backup is scheduled to be taken.", - "name": "schedule", - "type": "string" - }, - { - "description": "the time zone of the backup schedule", - "name": "timezone", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "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 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": "ID of the volume backed up", - "length": 255, - "name": "volumeid", - "required": true, + "description": "the name of the Load Balancer", + "name": "name", "type": "string" }, - { - "description": "ID of the VM backup", - "length": 255, - "name": "backupid", - "related": "updateBackupSchedule", - "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", + "description": "the account of the Load Balancer", + "name": "account", "type": "string" }, - {} - ], - "since": "4.14.0" - }, - { - "description": "Updates a user-defined VM backup schedule", - "isasync": false, - "name": "updateBackupSchedule", - "params": [ { - "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)", - "length": 255, - "name": "schedule", - "required": true, + "description": "the project id of the Load Balancer", + "name": "projectid", "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, + "description": "the Load Balancer ID", + "name": "id", "type": "string" }, { - "description": "ID of the VM for which schedule is to be defined", - "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": "valid values are HOURLY, DAILY, WEEKLY, and MONTHLY", - "length": 255, - "name": "intervaltype", - "required": true, - "type": "string" - } - ], - "related": "", - "response": [ - { - "description": "domain id", - "name": "domainid", + "description": "the project name of the Load Balancer", + "name": "project", "type": "string" }, {}, { - "description": "backup offering id", - "name": "backupofferingid", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "backup size in bytes", - "name": "size", - "type": "long" - }, - { - "description": "account id", - "name": "accountid", + "description": "the description of the Load Balancer", + "name": "description", "type": "string" }, { - "description": "domain name", - "name": "domain", - "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": "backup offering name", - "name": "backupofferingname", + "description": "Load Balancer network id", + "name": "networkid", "type": "string" }, { - "description": "backup type", - "name": "type", + "description": "the load balancer algorithm (source, roundrobin, leastconn)", + "name": "algorithm", "type": "string" }, { - "description": "ID of the VM", - "name": "virtualmachineid", + "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": "name of the VM", - "name": "virtualmachinename", + "description": "the domain ID of the Load Balancer", + "name": "domainid", "type": "string" - }, + } + ], + "since": "4.2.0" + }, + { + "description": "Removes network permissions.", + "isasync": false, + "name": "removeNetworkPermissions", + "params": [ { - "description": "account name", - "name": "account", - "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": "external backup id", - "name": "externalid", - "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": "zone id", - "name": "zoneid", - "type": "string" + "description": "the network ID", + "length": 255, + "name": "networkid", + "related": "createNetwork,updateNetwork,listNetworks", + "required": true, + "type": "uuid" }, { - "description": "zone name", - "name": "zone", - "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": "backed up volumes", - "name": "volumes", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "backup status", - "name": "status", - "type": "status" + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" }, + {}, { - "description": "backup protected (virtual) size in bytes", - "name": "virtualsize", - "type": "long" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, { - "description": "backup date", - "name": "created", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, - { - "description": "ID of the VM backup", - "name": "id", - "type": "string" - } + {} ], - "since": "4.14.0" + "since": "4.17.0" }, { "description": "list baremetal pxe server", "isasync": false, "name": "listBaremetalPxeServers", "params": [ - { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, - { - "description": "Pxe server device ID", - "length": 255, - "name": "id", - "required": false, - "type": "long" - }, { "description": "List by keyword", "length": 255, @@ -113328,21 +114923,24 @@ "related": "", "required": true, "type": "uuid" - } - ], - "related": "", - "response": [ + }, { - "description": "device id of ", + "description": "Pxe server device ID", + "length": 255, "name": "id", - "type": "string" + "required": false, + "type": "long" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "", + "length": 255, + "name": "pagesize", + "required": false, "type": "integer" - }, + } + ], + "related": "", + "response": [ { "description": "url", "name": "url", @@ -113358,12 +114956,23 @@ "name": "provider", "type": "string" }, + { + "description": "device id of ", + "name": "id", + "type": "string" + }, + {}, { "description": "the physical network to which this external dhcp device belongs to", "name": "physicalnetworkid", "type": "string" }, - {} + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } ] }, { @@ -113379,11 +114988,12 @@ "type": "string" }, { - "description": "Credentials to reach Palo Alto firewall device", + "description": "the Physical Network ID", "length": 255, - "name": "password", + "name": "physicalnetworkid", + "related": "", "required": true, - "type": "string" + "type": "uuid" }, { "description": "supports only PaloAltoFirewall", @@ -113393,12 +115003,11 @@ "type": "string" }, { - "description": "the Physical Network ID", + "description": "Credentials to reach Palo Alto firewall device", "length": 255, - "name": "physicalnetworkid", - "related": "", + "name": "password", "required": true, - "type": "uuid" + "type": "string" }, { "description": "Credentials to reach Palo Alto firewall device", @@ -113411,8 +115020,13 @@ "related": "", "response": [ { - "description": "device state", - "name": "fwdevicestate", + "description": "the physical network to which this Palo Alto firewall belongs to", + "name": "physicalnetworkid", + "type": "string" + }, + { + "description": "the private interface of the external firewall", + "name": "privateinterface", "type": "string" }, { @@ -113421,38 +115035,34 @@ "type": "string" }, { - "description": "device id of the Palo Alto firewall", - "name": "fwdeviceid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the private security zone of the external firewall", - "name": "privatezone", + "description": "the timeout (in seconds) for requests to the external firewall", + "name": "timeout", "type": "string" }, { - "description": "device name", - "name": "fwdevicename", + "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 capacity", + "name": "fwdevicecapacity", + "type": "long" }, { "description": "the management IP address of the external firewall", "name": "ipaddress", "type": "string" }, + {}, { - "description": "name of the provider", - "name": "provider", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the private security zone of the external firewall", + "name": "privatezone", "type": "string" }, { @@ -113461,45 +115071,44 @@ "type": "string" }, { - "description": "the username that's used to log in to the external firewall", - "name": "username", + "description": "the number of times to retry requests to the external firewall", + "name": "numretries", "type": "string" }, - {}, { - "description": "device capacity", - "name": "fwdevicecapacity", - "type": "long" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, {}, { - "description": "the timeout (in seconds) for requests to the external firewall", - "name": "timeout", + "description": "the public interface of the external firewall", + "name": "publicinterface", "type": "string" }, { - "description": "the number of times to retry requests to the external firewall", - "name": "numretries", + "description": "device name", + "name": "fwdevicename", "type": "string" }, { - "description": "the physical network to which this Palo Alto firewall belongs to", - "name": "physicalnetworkid", + "description": "the username that's used to log in to the external firewall", + "name": "username", "type": "string" }, { - "description": "the private interface of the external firewall", - "name": "privateinterface", + "description": "the usage interface of the external firewall", + "name": "usageinterface", "type": "string" }, { - "description": "the usage interface of the external firewall", - "name": "usageinterface", + "description": "device id of the Palo Alto firewall", + "name": "fwdeviceid", "type": "string" }, { - "description": "the public interface of the external firewall", - "name": "publicinterface", + "description": "name of the provider", + "name": "provider", "type": "string" } ] @@ -113510,38 +115119,48 @@ "name": "createPrivateGateway", "params": [ { - "description": "the gateway of the Private gateway", + "description": "the Physical Network ID the network belongs to", "length": 255, - "name": "gateway", - "required": true, - "type": "string" + "name": "physicalnetworkid", + "related": "", + "required": false, + "type": "uuid" }, { - "description": "when true bypasses VLAN id/range overlap check during private gateway creation", + "description": "The isolated network this private gateway is associated to.", "length": 255, - "name": "bypassvlanoverlapcheck", + "name": "associatednetworkid", + "related": "createNetwork,updateNetwork,listNetworks", "required": false, - "type": "boolean" + "since": "4.17.0", + "type": "uuid" }, { - "description": "the Physical Network ID the network belongs to", + "description": "the ID of the network ACL", "length": 255, - "name": "physicalnetworkid", - "related": "", + "name": "aclid", + "related": "createNetworkACLList", "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 network implementation uri for the private gateway", "length": 255, "name": "vlan", - "required": true, + "required": false, "type": "string" }, { - "description": "the IP address of the Private gateaway", + "description": "the netmask of the Private gateway", "length": 255, - "name": "ipaddress", + "name": "netmask", "required": true, "type": "string" }, @@ -113553,6 +115172,13 @@ "required": false, "type": "uuid" }, + { + "description": "the IP address of the Private gateaway", + "length": 255, + "name": "ipaddress", + "required": true, + "type": "string" + }, { "description": "source NAT supported value. Default value false. If 'true' source NAT is enabled on the private gateway 'false': sourcenat is not supported", "length": 255, @@ -113560,13 +115186,6 @@ "required": false, "type": "boolean" }, - { - "description": "the netmask of the Private gateway", - "length": 255, - "name": "netmask", - "required": true, - "type": "string" - }, { "description": "the VPC network belongs to", "length": 255, @@ -113576,81 +115195,90 @@ "type": "uuid" }, { - "description": "the ID of the network ACL", + "description": "the gateway of the Private gateway", "length": 255, - "name": "aclid", - "related": "createNetworkACLList", - "required": false, - "type": "uuid" + "name": "gateway", + "required": true, + "type": "string" } ], - "related": "", + "related": "createPrivateGateway", "response": [ - {}, { - "description": "the private gateway's ip address", - "name": "ipaddress", + "description": "the physical network id", + "name": "physicalnetworkid", "type": "string" }, { - "description": "VPC id the private gateway belongs to", - "name": "vpcid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "ACL name set for private gateway", - "name": "aclname", + "description": "the project name of the private gateway", + "name": "project", "type": "string" }, { - "description": "the project name of the private gateway", - "name": "project", + "description": "the account associated with the private gateway", + "name": "account", "type": "string" }, { - "description": "the physical network id", - "name": "physicalnetworkid", + "description": "ACL Id set for private gateway", + "name": "aclid", "type": "string" }, { - "description": "State of the gateway, can be Creating, Ready, Deleting", - "name": "state", + "description": "the private gateway's ip address", + "name": "ipaddress", "type": "string" }, { - "description": "the account associated with the private gateway", - "name": "account", + "description": "VPC name the private gateway belongs to", + "name": "vpcname", + "type": "string" + }, + { + "description": "the private gateway's netmask", + "name": "netmask", "type": "string" }, {}, { - "description": "ACL Id set for private gateway", - "name": "aclid", + "description": "the network implementation uri for the private gateway", + "name": "vlan", "type": "string" }, + {}, { "description": "the id of the private gateway", "name": "id", "type": "string" }, { - "description": "VPC name the private gateway belongs to", - "name": "vpcname", + "description": "the domain associated with the private gateway", + "name": "domain", "type": "string" }, { - "description": "the gateway", - "name": "gateway", + "description": "VPC id the private gateway belongs to", + "name": "vpcid", "type": "string" }, { - "description": "the name of the zone the private gateway belongs to", - "name": "zonename", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the project id of the private gateway", + "name": "projectid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the gateway", + "name": "gateway", "type": "string" }, { @@ -113659,41 +115287,47 @@ "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "ACL name set for private gateway", + "name": "aclname", + "type": "string" }, { "description": "the ID of the domain associated with the private gateway", "name": "domainid", "type": "string" }, + { + "description": "the ID of the Network associated with this private gateway", + "name": "associatednetworkid", + "type": "string" + }, { "description": "Souce Nat enable status", "name": "sourcenatsupported", "type": "boolean" }, { - "description": "the private gateway's netmask", - "name": "netmask", + "description": "State of the gateway, can be Creating, Ready, Deleting", + "name": "state", "type": "string" }, { - "description": "the project id of the private gateway", - "name": "projectid", + "description": "the name of the Network associated with this private gateway", + "name": "associatednetwork", "type": "string" }, { - "description": "the domain associated with the private gateway", - "name": "domain", + "description": "the name of the zone the private gateway belongs to", + "name": "zonename", "type": "string" }, { - "description": "the network implementation uri for the private gateway", - "name": "vlan", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" } - ] + ], + "since": "4.17.0" }, { "description": "Find user account by API key", @@ -113711,19 +115345,14 @@ "related": "", "response": [ { - "description": "the user state", - "name": "state", - "type": "string" - }, - { - "description": "the account ID of the user", - "name": "accountid", + "description": "the user lastname", + "name": "lastname", "type": "string" }, { - "description": "the ID of the role", - "name": "roleid", - "type": "string" + "description": "the account type of the user", + "name": "accounttype", + "type": "integer" }, { "description": "the type of the role", @@ -113731,23 +115360,13 @@ "type": "string" }, { - "description": "the api key of the user", - "name": "apikey", - "type": "string" - }, - { - "description": "true if user is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "the source type of the user in lowercase, such as native, ldap, saml2", - "name": "usersource", + "description": "the account name of the user", + "name": "account", "type": "string" }, { - "description": "the user email address", - "name": "email", + "description": "the user ID", + "name": "id", "type": "string" }, { @@ -113755,10 +115374,9 @@ "name": "rolename", "type": "string" }, - {}, { - "description": "the user firstname", - "name": "firstname", + "description": "the user email address", + "name": "email", "type": "string" }, { @@ -113767,33 +115385,44 @@ "type": "date" }, { - "description": "the user name", - "name": "username", + "description": "true if user is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "the ID of the role", + "name": "roleid", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the boolean value representing if the updating target is in caller's child domain", + "name": "iscallerchilddomain", + "type": "boolean" }, + {}, { - "description": "the domain name of the user", - "name": "domain", + "description": "the user firstname", + "name": "firstname", "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": "the account name of the user", - "name": "account", + "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 user lastname", - "name": "lastname", + "description": "the secret key of the user", + "name": "secretkey", "type": "string" }, { @@ -113807,29 +115436,34 @@ "type": "string" }, { - "description": "the account type of the user", - "name": "accounttype", - "type": "short" + "description": "the account ID of the user", + "name": "accountid", + "type": "string" }, + {}, { - "description": "the domain ID of the user", - "name": "domainid", + "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 UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the user ID", - "name": "id", + "description": "the user state", + "name": "state", "type": "string" }, { - "description": "the secret key of the user", - "name": "secretkey", + "description": "the domain name of the user", + "name": "domain", + "type": "string" + }, + { + "description": "the user name", + "name": "username", "type": "string" } ] @@ -113840,17 +115474,9 @@ "name": "listLoadBalancerRules", "params": [ { - "description": "the availability zone ID", - "length": 255, - "name": "zoneid", - "related": "listZones", - "required": false, - "type": "uuid" - }, - { - "description": "List by keyword", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "keyword", + "name": "account", "required": false, "type": "string" }, @@ -113862,18 +115488,25 @@ "type": "map" }, { - "description": "the ID of the virtual machine of the load balancer rule", + "description": "the public IP address ID 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", + "name": "publicipid", + "related": "associateIpAddress,listPublicIpAddresses", "required": false, "type": "uuid" }, { - "description": "list objects by project", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "projectid", - "related": "", + "name": "listall", + "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" }, @@ -113886,11 +115519,12 @@ "type": "uuid" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "the availability zone ID", "length": 255, - "name": "account", + "name": "zoneid", + "related": "listZones", "required": false, - "type": "string" + "type": "uuid" }, { "description": "list only resources belonging to the domain specified", @@ -113901,11 +115535,19 @@ "type": "uuid" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false", + "description": "the name of the load balancer rule", + "length": 255, + "name": "name", + "required": false, + "type": "string" + }, + { + "description": "the ID of the load balancer rule", "length": 255, - "name": "listall", + "name": "id", + "related": "", "required": false, - "type": "boolean" + "type": "uuid" }, { "description": "", @@ -113915,26 +115557,26 @@ "type": "integer" }, { - "description": "the name of the load balancer rule", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "name", + "name": "projectid", + "related": "", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "the public IP address ID of the load balancer rule", + "description": "List by keyword", "length": 255, - "name": "publicipid", - "related": "associateIpAddress,listPublicIpAddresses", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "", "length": 255, - "name": "isrecursive", + "name": "page", "required": false, - "type": "boolean" + "type": "integer" }, { "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", @@ -113945,47 +115587,69 @@ "type": "boolean" }, { - "description": "the ID of the load balancer rule", - "length": 255, - "name": "id", - "related": "", - "required": false, - "type": "uuid" - }, - { - "description": "", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "page", + "name": "isrecursive", "required": false, - "type": "integer" + "type": "boolean" } ], "related": "", "response": [ { - "description": "the private port", - "name": "privateport", + "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", "type": "string" }, { - "description": "the description of the load balancer", - "name": "description", + "description": "the project name of the load balancer", + "name": "project", + "type": "string" + }, + { + "description": "the domain ID of the load balancer rule", + "name": "domainid", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the project id of the load balancer", + "name": "projectid", + "type": "string" + }, + { + "description": "the public ip address id", + "name": "publicipid", + "type": "string" + }, + { + "description": "the load balancer rule ID", + "name": "id", + "type": "string" + }, + { + "description": "the id of the guest network the lb rule belongs to", + "name": "networkid", "type": "string" }, {}, { - "description": "is rule for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "the 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 cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", + "description": "the protocol of the loadbalanacer rule", + "name": "protocol", "type": "string" }, { @@ -113994,8 +115658,29 @@ "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the id of the zone the rule belongs to", + "name": "zoneid", + "type": "string" + }, + { + "description": "the public ip address", + "name": "publicip", + "type": "string" + }, + { + "description": "is rule for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, + {}, + { + "description": "the name of the zone the load balancer rule belongs to", + "name": "zonename", + "type": "string" + }, + { + "description": "the private port", + "name": "privateport", "type": "string" }, { @@ -114003,18 +115688,18 @@ "name": "tags", "response": [ { - "description": "id of the resource", - "name": "resourceid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "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" }, { @@ -114023,41 +115708,41 @@ "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "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 account associated with the tag", - "name": "account", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" } ], "type": "list" }, { - "description": "the id of the guest network the lb rule belongs to", - "name": "networkid", + "description": "the load balancer algorithm (source, roundrobin, leastconn)", + "name": "algorithm", "type": "string" }, { @@ -114065,70 +115750,19 @@ "name": "state", "type": "string" }, - { - "description": "the account of the load balancer rule", - "name": "account", - "type": "string" - }, - {}, - { - "description": "the id of the zone the rule belongs to", - "name": "zoneid", - "type": "string" - }, - { - "description": "the project name of the load balancer", - "name": "project", - "type": "string" - }, - { - "description": "the load balancer rule ID", - "name": "id", - "type": "string" - }, - { - "description": "the public ip address id", - "name": "publicipid", - "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 domain ID of the load balancer rule", - "name": "domainid", - "type": "string" - }, - { - "description": "the project id of the load balancer", - "name": "projectid", - "type": "string" - }, - { - "description": "the name of the zone the load balancer rule belongs to", - "name": "zonename", - "type": "string" - }, - { - "description": "the domain of the load balancer rule", - "name": "domain", - "type": "string" - }, - { - "description": "the load balancer algorithm (source, roundrobin, leastconn)", - "name": "algorithm", + "description": "the description of the load balancer", + "name": "description", "type": "string" }, { - "description": "the public ip address", - "name": "publicip", + "description": "the public port", + "name": "publicport", "type": "string" } ] @@ -114159,17 +115793,17 @@ "name": "jobstatus", "type": "integer" }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, + {}, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, - {} + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + } ] }, { @@ -114178,25 +115812,17 @@ "name": "uploadSslCert", "params": [ { - "description": "Private key", - "length": 16384, - "name": "privatekey", - "required": true, - "type": "string" - }, - { - "description": "domain ID of the account owning the SSL certificate", + "description": "Password for the private key", "length": 255, - "name": "domainid", - "related": "listDomains", + "name": "password", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "Name for the uploaded certificate", + "description": "account that will own the SSL certificate", "length": 255, - "name": "name", - "required": true, + "name": "account", + "required": false, "type": "string" }, { @@ -114208,10 +115834,10 @@ "type": "boolean" }, { - "description": "account that will own the SSL certificate", + "description": "Name for the uploaded certificate", "length": 255, - "name": "account", - "required": false, + "name": "name", + "required": true, "type": "string" }, { @@ -114221,6 +115847,21 @@ "required": true, "type": "string" }, + { + "description": "Private key", + "length": 16384, + "name": "privatekey", + "required": true, + "type": "string" + }, + { + "description": "domain ID of the account owning the SSL certificate", + "length": 255, + "name": "domainid", + "related": "listDomains", + "required": false, + "type": "uuid" + }, { "description": "Certificate chain of trust", "length": 2097152, @@ -114235,46 +115876,45 @@ "related": "", "required": false, "type": "uuid" - }, - { - "description": "Password for the private key", - "length": 255, - "name": "password", - "required": false, - "type": "string" } ], "related": "", "response": [ { - "description": "the domain id of the network owner", - "name": "domainid", + "description": "name", + "name": "name", "type": "string" }, - {}, { - "description": "SSL certificate ID", - "name": "id", + "description": "certificate fingerprint", + "name": "fingerprint", "type": "string" }, { - "description": "the project name of the certificate", - "name": "project", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the domain id of the network owner", + "name": "domainid", "type": "string" }, + {}, { - "description": "certificate fingerprint", - "name": "fingerprint", + "description": "account for the certificate", + "name": "account", "type": "string" }, { - "description": "certificate chain", - "name": "certchain", + "description": "the domain name of the network owner", + "name": "domain", "type": "string" }, + {}, { - "description": "certificate", - "name": "certificate", + "description": "the project name of the certificate", + "name": "project", "type": "string" }, { @@ -114288,30 +115928,24 @@ "type": "string" }, { - "description": "name", - "name": "name", + "description": "the project id of the certificate", + "name": "projectid", "type": "string" }, { - "description": "account for the certificate", - "name": "account", + "description": "SSL certificate ID", + "name": "id", "type": "string" }, - {}, { - "description": "the domain name of the network owner", - "name": "domain", + "description": "certificate", + "name": "certificate", "type": "string" }, { - "description": "the project id of the certificate", - "name": "projectid", + "description": "certificate chain", + "name": "certchain", "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" } ] }, @@ -114321,26 +115955,24 @@ "name": "createVpnCustomerGateway", "params": [ { - "description": "create site-to-site VPN customer gateway for the project", + "description": "IPsec Preshared-Key of the customer gateway. Cannot contain newline or double quotes.", "length": 255, - "name": "projectid", - "related": "", - "required": false, - "since": "4.6", - "type": "uuid" + "name": "ipsecpsk", + "required": true, + "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.", + "description": "For IKEv2, whether to split multiple right subnet cidrs into multiple connection statements.", "length": 255, - "name": "domainid", - "related": "listDomains", + "name": "splitconnections", "required": false, - "type": "uuid" + "since": "4.15.1", + "type": "boolean" }, { - "description": "ESP policy of the customer gateway", + "description": "public ip address id of the customer gateway", "length": 255, - "name": "esppolicy", + "name": "gateway", "required": true, "type": "string" }, @@ -114359,12 +115991,11 @@ "type": "string" }, { - "description": "For IKEv2, whether to split multiple right subnet cidrs into multiple connection statements.", + "description": "name of this customer gateway", "length": 255, - "name": "splitconnections", + "name": "name", "required": false, - "since": "4.15.1", - "type": "boolean" + "type": "string" }, { "description": "Lifetime of phase 2 VPN connection to the customer gateway, in seconds", @@ -114373,13 +116004,6 @@ "required": false, "type": "long" }, - { - "description": "IPsec Preshared-Key of the customer gateway. Cannot contain newline or double quotes.", - "length": 255, - "name": "ipsecpsk", - "required": true, - "type": "string" - }, { "description": "Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Connections marked with 'ike' will use 'ikev2' when initiating, but accept any protocol version when responding. Defaults to ike", "length": 255, @@ -114389,30 +116013,40 @@ "type": "string" }, { - "description": "If DPD is enabled for VPN connection", + "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": "dpd", + "name": "domainid", + "related": "listDomains", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "guest cidr list of the customer gateway. Multiple entries must be separated by a single comma character (,).", + "description": "create site-to-site VPN customer gateway for the project", "length": 255, - "name": "cidrlist", - "required": true, - "type": "string" + "name": "projectid", + "related": "", + "required": false, + "since": "4.6", + "type": "uuid" }, { - "description": "name of this customer gateway", + "description": "Lifetime of phase 1 VPN connection to the customer gateway, in seconds", "length": 255, - "name": "name", + "name": "ikelifetime", "required": false, + "type": "long" + }, + { + "description": "guest cidr list of the customer gateway. Multiple entries must be separated by a single comma character (,).", + "length": 255, + "name": "cidrlist", + "required": true, "type": "string" }, { - "description": "public ip address id of the customer gateway", + "description": "ESP policy of the customer gateway", "length": 255, - "name": "gateway", + "name": "esppolicy", "required": true, "type": "string" }, @@ -114424,23 +116058,18 @@ "type": "string" }, { - "description": "Lifetime of phase 1 VPN connection to the customer gateway, in seconds", + "description": "If DPD is enabled for VPN connection", "length": 255, - "name": "ikelifetime", + "name": "dpd", "required": false, - "type": "long" + "type": "boolean" } ], "related": "", "response": [ { - "description": "guest cidr list of the customer gateway. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", - "type": "string" - }, - { - "description": "public ip address id of the customer gateway", - "name": "gateway", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -114453,34 +116082,34 @@ "name": "esplifetime", "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": "For IKEv2, whether to split multiple right subnet cidrs into multiple connection statements.", - "name": "splitconnections", - "type": "boolean" + "description": "the domain id of the owner", + "name": "domainid", + "type": "string" }, { - "description": "the date and time the host was removed", - "name": "removed", - "type": "date" + "description": "IPsec preshared-key of customer gateway", + "name": "ipsecpsk", + "type": "string" }, { - "description": "IPsec policy of customer gateway", - "name": "esppolicy", + "description": "guest cidr list of the customer gateway. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", "type": "string" }, { - "description": "the domain id of the owner", - "name": "domainid", + "description": "if DPD is enabled for customer gateway", + "name": "dpd", + "type": "boolean" + }, + { + "description": "guest ip of the customer gateway", + "name": "ipaddress", "type": "string" }, { @@ -114489,50 +116118,54 @@ "type": "string" }, { - "description": "the project name", - "name": "project", + "description": "IKE policy of customer gateway", + "name": "ikepolicy", "type": "string" }, - {}, { - "description": "IPsec preshared-key of customer gateway", - "name": "ipsecpsk", + "description": "Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Defaults to ike", + "name": "ikeversion", "type": "string" }, { - "description": "the owner", - "name": "account", + "description": "the project name", + "name": "project", "type": "string" }, { - "description": "the vpn gateway ID", - "name": "id", + "description": "public ip address id of the customer gateway", + "name": "gateway", "type": "string" }, - {}, { - "description": "if Force NAT Encapsulation is enabled for customer gateway", - "name": "forceencap", + "description": "For IKEv2, whether to split multiple right subnet cidrs into multiple connection statements.", + "name": "splitconnections", "type": "boolean" }, { - "description": "name of the customer gateway", - "name": "name", + "description": "IPsec policy of customer gateway", + "name": "esppolicy", "type": "string" }, + {}, { - "description": "IKE policy of customer gateway", - "name": "ikepolicy", + "description": "the owner", + "name": "account", "type": "string" }, { - "description": "Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Defaults to ike", - "name": "ikeversion", - "type": "string" + "description": "if Force NAT Encapsulation is enabled for customer gateway", + "name": "forceencap", + "type": "boolean" }, { - "description": "guest ip of the customer gateway", - "name": "ipaddress", + "description": "the date and time the host was removed", + "name": "removed", + "type": "date" + }, + { + "description": "name of the customer gateway", + "name": "name", "type": "string" }, { @@ -114540,15 +116173,16 @@ "name": "projectid", "type": "string" }, + {}, + { + "description": "the vpn gateway ID", + "name": "id", + "type": "string" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - }, - { - "description": "if DPD is enabled for customer gateway", - "name": "dpd", - "type": "boolean" } ] }, @@ -114558,18 +116192,17 @@ "name": "createManagementNetworkIpRange", "params": [ { - "description": "UUID of POD, where the IP range belongs to.", + "description": "The gateway for the management network.", "length": 255, - "name": "podid", - "related": "createManagementNetworkIpRange", + "name": "gateway", "required": true, - "type": "uuid" + "type": "string" }, { - "description": "The ending IP address.", + "description": "The starting IP address.", "length": 255, - "name": "endip", - "required": false, + "name": "startip", + "required": true, "type": "string" }, { @@ -114580,72 +116213,37 @@ "type": "boolean" }, { - "description": "Optional. The vlan id the ip range sits on, default to Null when it is not specificed which means you network is not on any Vlan", + "description": "The netmask for the management network.", "length": 255, - "name": "vlan", - "required": false, + "name": "netmask", + "required": true, "type": "string" }, { - "description": "The gateway for the management network.", + "description": "The ending IP address.", "length": 255, - "name": "gateway", - "required": true, + "name": "endip", + "required": false, "type": "string" }, { - "description": "The netmask for the management network.", + "description": "Optional. The vlan id the ip range sits on, default to Null when it is not specified which means you network is not on any Vlan", "length": 255, - "name": "netmask", - "required": true, + "name": "vlan", + "required": false, "type": "string" }, { - "description": "The starting IP address.", + "description": "UUID of POD, where the IP range belongs to.", "length": 255, - "name": "startip", + "name": "podid", + "related": "createManagementNetworkIpRange", "required": true, - "type": "string" + "type": "uuid" } ], "related": "", "response": [ - { - "description": "indicates Vlan ID for the range. This parameter is deprecated, please use 'vlanid' from ipranges parameter.", - "name": "vlanid", - "type": "list" - }, - { - "description": "the Zone name of the Pod", - "name": "zonename", - "type": "string" - }, - { - "description": "the name of the Pod", - "name": "name", - "type": "string" - }, - { - "description": "the starting IP for the Pod. This parameter is deprecated, please use 'startip' from ipranges parameter.", - "name": "startip", - "type": "list" - }, - { - "description": "indicates if range is dedicated for CPVM and SSVM. This parameter is deprecated, please use 'forsystemvms' from ipranges parameter.", - "name": "forsystemvms", - "type": "list" - }, - { - "description": "the gateway of the Pod", - "name": "gateway", - "type": "string" - }, - {}, - { - "description": "the allocation state of the Pod", - "name": "allocationstate", - "type": "string" - }, { "description": "the capacity of the Pod", "name": "capacity", @@ -114656,23 +116254,28 @@ "type": "string" }, { - "description": "the Zone name", - "name": "zonename", + "description": "the Zone ID", + "name": "zoneid", "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", - "type": "string" + "description": "the capacity type", + "name": "type", + "type": "short" }, { - "description": "the Zone ID", - "name": "zoneid", + "description": "the capacity currently in use", + "name": "capacityused", + "type": "long" + }, + { + "description": "the Zone name", + "name": "zonename", "type": "string" }, { @@ -114681,100 +116284,141 @@ "type": "string" }, { - "description": "the Pod ID", - "name": "podid", + "description": "the Pod name", + "name": "podname", "type": "string" }, { - "description": "the capacity currently in allocated", - "name": "capacityallocated", - "type": "long" - }, - { - "description": "the capacity currently in use", - "name": "capacityused", - "type": "long" - }, - { - "description": "the capacity type", - "name": "type", - "type": "short" + "description": "the Cluster name", + "name": "clustername", + "type": "string" }, { - "description": "the Pod name", - "name": "podname", + "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" } ], "type": "list" }, + {}, { - "description": "the Zone ID of the Pod", - "name": "zoneid", + "description": "the ID of the Pod", + "name": "id", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the allocation state of the Pod", + "name": "allocationstate", + "type": "string" + }, + { + "description": "the starting IP for the Pod. This parameter is deprecated, please use 'startip' from ipranges parameter.", + "name": "startip", + "type": "list" }, { "description": "true if the entity/resource has annotations", "name": "hasannotations", "type": "boolean" }, - {}, { "description": "the netmask of the Pod", "name": "netmask", "type": "string" }, + { + "description": "indicates Vlan ID for the range. This parameter is deprecated, please use 'vlanid' from ipranges parameter.", + "name": "vlanid", + "type": "list" + }, { "description": "the IP ranges for the Pod", "name": "ipranges", "response": [ { - "description": "indicates Vlan ID for the range", - "name": "vlanid", + "description": "the gateway for the range", + "name": "gateway", "type": "string" }, { - "description": "indicates if range is dedicated for CPVM and SSVM", - "name": "forsystemvms", + "description": "the starting IP for the range", + "name": "startip", "type": "string" }, { - "description": "the starting IP for the range", - "name": "startip", + "description": "the CIDR for the range", + "name": "cidr", "type": "string" }, { "description": "the ending IP for the range", "name": "endip", "type": "string" + }, + { + "description": "indicates if range is dedicated for CPVM and SSVM", + "name": "forsystemvms", + "type": "string" + }, + { + "description": "indicates Vlan ID for the range", + "name": "vlanid", + "type": "string" } ], "type": "list" }, { - "description": "the ending IP for the Pod. This parameter is deprecated, please use 'endip' from ipranges parameter.", - "name": "endip", + "description": "the gateway of the Pod", + "name": "gateway", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "indicates if range is dedicated for CPVM and SSVM. This parameter is deprecated, please use 'forsystemvms' from ipranges parameter.", + "name": "forsystemvms", "type": "list" }, + { + "description": "the Zone ID of the Pod", + "name": "zoneid", + "type": "string" + }, + { + "description": "the Zone name of the Pod", + "name": "zonename", + "type": "string" + }, + { + "description": "the name of the Pod", + "name": "name", + "type": "string" + }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, + {}, { - "description": "the ID of the Pod", - "name": "id", - "type": "string" + "description": "the ending IP for the Pod. This parameter is deprecated, please use 'endip' from ipranges parameter.", + "name": "endip", + "type": "list" } ], "since": "4.11.0.0" @@ -114785,11 +116429,12 @@ "name": "listCiscoNexusVSMs", "params": [ { - "description": "", + "description": "Id of the CloudStack cluster in which the Cisco Nexus 1000v VSM appliance.", "length": 255, - "name": "page", + "name": "zoneid", + "related": "listZones", "required": false, - "type": "integer" + "type": "uuid" }, { "description": "List by keyword", @@ -114799,12 +116444,11 @@ "type": "string" }, { - "description": "Id of the CloudStack cluster in which the Cisco Nexus 1000v VSM appliance.", + "description": "", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" }, { "description": "Id of the CloudStack cluster in which the Cisco Nexus 1000v VSM appliance.", @@ -114817,7 +116461,7 @@ { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" } @@ -114825,44 +116469,33 @@ "related": "", "response": [ { - "description": "device id of the Cisco N1KV VSM device", - "name": "vsmdeviceid", - "type": "string" - }, - {}, - { - "description": "device name", - "name": "vsmdevicename", + "description": "The VSM is a switch supervisor. This is the VSM's switch domain id", + "name": "vsmdomainid", "type": "string" }, - { - "description": "packet vlan id of the VSM", - "name": "vsmpktvlanid", - "type": "int" - }, { "description": "management vlan id of the VSM", "name": "vsmmgmtvlanid", "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": "control vlan id of the VSM", - "name": "vsmctrlvlanid", - "type": "int" + "description": "The mode of the VSM (standalone/HA)", + "name": "vsmconfigmode", + "type": "string" }, { - "description": "The VSM is a switch supervisor. This is the VSM's switch domain id", - "name": "vsmdomainid", + "description": "device state", + "name": "vsmdevicestate", "type": "string" }, { - "description": "The Config State (Primary/Standby) of the VSM", - "name": "vsmconfigstate", + "description": "the management IP address of the external Cisco Nexus 1000v Virtual Supervisor Module", + "name": "ipaddress", "type": "string" }, { @@ -114870,31 +116503,42 @@ "name": "vsmstoragevlanid", "type": "int" }, + {}, { - "description": "the management IP address of the external Cisco Nexus 1000v Virtual Supervisor Module", - "name": "ipaddress", + "description": "device id of the Cisco N1KV VSM device", + "name": "vsmdeviceid", "type": "string" }, { - "description": "device state", + "description": "The Device State (Enabled/Disabled) of the VSM", "name": "vsmdevicestate", "type": "string" }, { - "description": "The mode of the VSM (standalone/HA)", - "name": "vsmconfigmode", + "description": "The Config State (Primary/Standby) of the VSM", + "name": "vsmconfigstate", "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 Device State (Enabled/Disabled) of the VSM", - "name": "vsmdevicestate", + "description": "packet vlan id of the VSM", + "name": "vsmpktvlanid", + "type": "int" + }, + { + "description": "device name", + "name": "vsmdevicename", "type": "string" + }, + { + "description": "control vlan id of the VSM", + "name": "vsmctrlvlanid", + "type": "int" } ] }, @@ -114903,13 +116547,6 @@ "isasync": true, "name": "addVpnUser", "params": [ - { - "description": "username for the vpn user", - "length": 255, - "name": "username", - "required": true, - "type": "string" - }, { "description": "an optional domainId for the vpn user. If the account parameter is used, domainId must also be used.", "length": 255, @@ -114918,20 +116555,6 @@ "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": "password for the username", - "length": 255, - "name": "password", - "required": true, - "type": "string" - }, { "description": "add vpn user to the specific project", "length": 255, @@ -114939,149 +116562,57 @@ "related": "", "required": false, "type": "uuid" - } - ], - "related": "", - "response": [ - { - "description": "the domain name of the account of the remote access vpn", - "name": "domain", - "type": "string" - }, - { - "description": "the project id of the vpn", - "name": "projectid", - "type": "string" - }, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the vpn userID", - "name": "id", - "type": "string" }, { - "description": "the username of the vpn user", + "description": "username for the vpn user", + "length": 255, "name": "username", + "required": true, "type": "string" }, { - "description": "the domain id of the account of the remote access vpn", - "name": "domainid", - "type": "string" - }, - { - "description": "the account of the remote access vpn", - "name": "account", - "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 state of the Vpn User", - "name": "state", - "type": "string" - } - ] - }, - { - "description": "Delete VM backup", - "isasync": true, - "name": "deleteBackup", - "params": [ - { - "description": "id of the VM backup", + "description": "an optional account for the vpn user. Must be used with domainId.", "length": 255, - "name": "id", - "related": "", - "required": true, - "type": "uuid" - } - ], - "response": [ - {}, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "name": "account", + "required": false, "type": "string" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - } - ], - "since": "4.14.0" - }, - { - "description": "remove an annotation.", - "isasync": false, - "name": "removeAnnotation", - "params": [ - { - "description": "the id of the annotation", + "description": "password for the username", "length": 255, - "name": "id", + "name": "password", "required": true, "type": "string" } ], "related": "", "response": [ + {}, { - "description": "the (uu)id of the entitiy to which this annotation pertains", - "name": "entityid", + "description": "the vpn userID", + "name": "id", "type": "string" }, {}, { - "description": "the contents of the annotation", - "name": "annotation", + "description": "the username of the vpn user", + "name": "username", "type": "string" }, { - "description": "the (uu)id of the annotation", - "name": "id", + "description": "the account of the remote access vpn", + "name": "account", "type": "string" }, { - "description": "the creation timestamp for this annotation", - "name": "created", - "type": "date" - }, - { - "description": "The username of the user that entered the annotation", - "name": "username", + "description": "the project id of the vpn", + "name": "projectid", "type": "string" }, { - "description": "True if the annotation is available for admins only", - "name": "adminsonly", - "type": "boolean" + "description": "the domain id of the account of the remote access vpn", + "name": "domainid", + "type": "string" }, { "description": "the current status of the latest async job acting on this object", @@ -115089,33 +116620,26 @@ "type": "integer" }, { - "description": "the type of the annotated entity", - "name": "entitytype", + "description": "the domain name of the account of the remote access vpn", + "name": "domain", "type": "string" }, { - "description": "the name of the entitiy to which this annotation pertains", - "name": "entityname", + "description": "the state of the Vpn User", + "name": "state", "type": "string" }, { - "description": "The (uu)id of the user that entered the annotation", - "name": "userid", + "description": "the project name of the vpn", + "name": "project", "type": "string" }, - { - "description": "the removal timestamp for this annotation", - "name": "removed", - "type": "date" - }, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" } - ], - "since": "4.11" + ] }, { "description": "add a baremetal host", @@ -115137,10 +116661,17 @@ "type": "string" }, { - "description": "the Pod ID for the host", + "description": "list of tags to be added to the host", "length": 255, - "name": "podid", - "related": "", + "name": "hosttags", + "required": false, + "type": "list" + }, + { + "description": "the Zone ID for the host", + "length": 255, + "name": "zoneid", + "related": "listZones", "required": true, "type": "uuid" }, @@ -115152,13 +116683,6 @@ "required": false, "type": "uuid" }, - { - "description": "the cluster name for the host", - "length": 255, - "name": "clustername", - "required": false, - "type": "string" - }, { "description": "ip address intentionally allocated to this host after provisioning", "length": 255, @@ -115167,19 +116691,11 @@ "type": "string" }, { - "description": "the Zone ID for the host", - "length": 255, - "name": "zoneid", - "related": "listZones", - "required": true, - "type": "uuid" - }, - { - "description": "list of tags to be added to the host", + "description": "the password for the host; required to be passed for hypervisors other than VMWare", "length": 255, - "name": "hosttags", + "name": "password", "required": false, - "type": "list" + "type": "string" }, { "description": "the username for the host; required to be passed for hypervisors other than VMWare", @@ -115189,12 +116705,20 @@ "type": "string" }, { - "description": "the password for the host; required to be passed for hypervisors other than VMWare", + "description": "the cluster name for the host", "length": 255, - "name": "password", + "name": "clustername", "required": false, "type": "string" }, + { + "description": "the Pod ID for the host", + "length": 255, + "name": "podid", + "related": "", + "required": true, + "type": "uuid" + }, { "description": "Allocation state of this Host for allocation of new resources", "length": 255, @@ -115206,201 +116730,197 @@ "related": "", "response": [ { - "description": "the cluster type of the cluster that host belongs to", - "name": "clustertype", + "description": "the amount of the host's memory currently allocated", + "name": "memoryallocated", + "type": "long" + }, + {}, + { + "description": "the date and time the host was last pinged", + "name": "lastpinged", + "type": "date" + }, + { + "description": "the OS category ID of the host", + "name": "oscategoryid", "type": "string" }, { - "description": "the Zone ID of the host", - "name": "zoneid", - "type": "string" + "description": "the host out-of-band management information", + "name": "outofbandmanagement", + "type": "outofbandmanagementresponse" + }, + { + "description": "the host hypervisor", + "name": "hypervisor", + "type": "hypervisortype" }, { - "description": "the hypervisor version", - "name": "hypervisorversion", + "description": "the Pod ID of the host", + "name": "podid", "type": "string" }, { - "description": "the Zone name of the host", - "name": "zonename", + "description": "the cluster type of the cluster that host belongs to", + "name": "clustertype", "type": "string" }, { - "description": "true if the host is disconnected. False otherwise.", - "name": "disconnected", - "type": "date" + "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", + "name": "memorytotal", + "type": "long" }, { - "description": "the host HA information information", - "name": "hostha", - "type": "hostharesponse" + "description": "the cluster ID of the host", + "name": "clusterid", + "type": "string" }, { - "description": "the last time this host was annotated", - "name": "lastannotated", - "type": "date" + "description": "the last annotation set on this host by an admin", + "name": "annotation", + "type": "string" }, { - "description": "the outgoing network traffic on the host", - "name": "networkkbswrite", + "description": "the total disk size of the host", + "name": "disksizetotal", "type": "long" }, { - "description": "true if this host is suitable(has enough capacity and satisfies all conditions like hosttags, max guests vm limit etc) to migrate a VM to it , false otherwise", - "name": "suitableformigration", - "type": "boolean" - }, - { - "description": "the date and time the host was last pinged", - "name": "lastpinged", - "type": "date" + "description": "the incoming network traffic on the host", + "name": "networkkbsread", + "type": "long" }, { - "description": "true if the host has capability to support UEFI boot", - "name": "ueficapability", - "type": "boolean" + "description": "the cpu average load on the host", + "name": "cpuloadaverage", + "type": "double" }, { - "description": "the date and time the host was removed", - "name": "removed", - "type": "date" + "description": "the name of the host", + "name": "name", + "type": "string" }, { - "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", - "name": "cpuallocatedwithoverprovisioning", - "type": "string" + "description": "the host HA information information", + "name": "hostha", + "type": "hostharesponse" }, { - "description": "the resource state of the host", - "name": "resourcestate", + "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor", + "name": "cpuwithoverprovisioning", "type": "string" }, { - "description": "the amount of the host's memory currently allocated", - "name": "memoryallocated", + "description": "the amount of the host's memory currently used", + "name": "memoryused", "type": "long" }, { - "description": "the number of CPU sockets on the host", - "name": "cpusockets", - "type": "integer" + "description": "the OS category name of the host", + "name": "oscategoryname", + "type": "string" }, { - "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", - "name": "memorytotal", - "type": "long" + "description": "the Zone name of the host", + "name": "zonename", + "type": "string" }, { - "description": "the state of the host", - "name": "state", - "type": "status" + "description": "capabilities of the host", + "name": "capabilities", + "type": "string" }, { - "description": "the CPU speed of the host", - "name": "cpuspeed", - "type": "long" + "description": "true if the host is disconnected. False otherwise.", + "name": "disconnected", + "type": "date" }, { - "description": "the Pod name of the host", - "name": "podname", + "description": "events available for the host", + "name": "events", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "true if this host is suitable(has enough capacity and satisfies all conditions like hosttags, max guests vm limit etc) to migrate a VM to it , false otherwise", + "name": "suitableformigration", "type": "boolean" }, { - "description": "the amount of the host's CPU currently allocated", - "name": "cpuallocated", + "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 amount of the host's memory after applying the mem.overprovisioning.factor", - "name": "memorywithoverprovisioning", + "description": "the Zone ID of the host", + "name": "zoneid", "type": "string" }, { - "description": "the last annotation set on this host by an admin", - "name": "annotation", + "description": "comma-separated list of tags for the host", + "name": "hosttags", "type": "string" }, { - "description": "the OS category name of the host", - "name": "oscategoryname", + "description": "the amount of the host's memory after applying the mem.overprovisioning.factor", + "name": "memorywithoverprovisioning", "type": "string" }, { - "description": "true if local storage is active, false otherwise", - "name": "islocalstorageactive", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "the host type", - "name": "type", - "type": "type" + "description": "the management server ID of the host", + "name": "managementserverid", + "type": "string" }, { - "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 host version", - "name": "version", - "type": "string" + "description": "the date and time the host was removed", + "name": "removed", + "type": "date" }, { - "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor", - "name": "cpuwithoverprovisioning", + "description": "the resource state of the host", + "name": "resourcestate", "type": "string" }, { - "description": "the incoming network traffic on the host", - "name": "networkkbsread", - "type": "long" + "description": "the state of the host", + "name": "state", + "type": "status" }, { - "description": "the total disk size of the host", - "name": "disksizetotal", + "description": "the amount of the host's memory currently allocated in bytes", + "name": "memoryallocatedbytes", "type": "long" }, - { - "description": "the OS category ID of the host", - "name": "oscategoryid", - "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", + "description": "Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type", + "name": "remainingcapacity", "type": "long" }, { - "description": "Maximum displays per user", - "name": "maxheads", + "description": "Maximum vgpu can be created with this vgpu type on the given gpu group", + "name": "maxcapacity", "type": "long" }, { - "description": "Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type", - "name": "remainingcapacity", + "description": "Maximum no. of vgpu per gpu card (pgpu)", + "name": "maxvgpuperpgpu", "type": "long" }, { @@ -115409,96 +116929,135 @@ "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", + "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" }, { - "description": "Maximum X resolution per display", - "name": "maxresolutionx", + "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 amount of the host's CPU currently used", + "name": "cpuused", + "type": "string" + }, + { + "description": "the amount of the host's CPU currently allocated", + "name": "cpuallocated", + "type": "string" + }, + { + "description": "the IP address of the host", + "name": "ipaddress", + "type": "string" + }, + { + "description": "true if local storage is active, false otherwise", + "name": "islocalstorageactive", + "type": "boolean" + }, { "description": "the amount of the host's CPU currently allocated in MHz", "name": "cpuallocatedvalue", "type": "long" }, { - "description": "the amount of the host's memory currently used", - "name": "memoryused", + "description": "the host's currently allocated disk size", + "name": "disksizeallocated", "type": "long" }, { - "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 date and time the host was created", - "name": "created", + "description": "the last time this host was annotated", + "name": "lastannotated", "type": "date" }, { - "description": "events available for the host", - "name": "events", - "type": "string" + "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise", + "name": "hahost", + "type": "boolean" }, { - "description": "the cluster ID of the host", - "name": "clusterid", - "type": "string" + "description": "true if the host has capability to support UEFI boot", + "name": "ueficapability", + "type": "boolean" }, { - "description": "the Pod ID of the host", - "name": "podid", - "type": "string" + "description": "the number of CPU sockets on the host", + "name": "cpusockets", + "type": "integer" }, { - "description": "the admin that annotated this host", - "name": "username", + "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", + "name": "cpuallocatedwithoverprovisioning", "type": "string" }, { - "description": "the IP address of the host", - "name": "ipaddress", + "description": "the date and time the host was created", + "name": "created", + "type": "date" + }, + { + "description": "the host version", + "name": "version", "type": "string" }, { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", + "description": "the CPU speed of the host", + "name": "cpuspeed", "type": "long" }, - {}, { - "description": "the host hypervisor", - "name": "hypervisor", - "type": "hypervisortype" + "description": "the host type", + "name": "type", + "type": "type" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the admin that annotated this host", + "name": "username", "type": "string" }, { - "description": "the cpu average load on the host", - "name": "cpuloadaverage", - "type": "double" + "description": "true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise", + "name": "hasenoughcapacity", + "type": "boolean" + }, + { + "description": "the Pod name of the host", + "name": "podname", + "type": "string" + }, + { + "description": "the outgoing network traffic on the host", + "name": "networkkbswrite", + "type": "long" }, { "description": "Host details in key/value pairs.", @@ -115506,67 +117065,112 @@ "type": "map" }, { - "description": "the amount of the host's memory currently allocated in percentage", - "name": "memoryallocatedpercentage", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the ID of the host", + "name": "id", "type": "string" }, + {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "the CPU number of the host", + "name": "cpunumber", "type": "integer" }, { - "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise", - "name": "hahost", - "type": "boolean" + "description": "the cluster name of the host", + "name": "clustername", + "type": "string" }, { - "description": "capabilities of the host", - "name": "capabilities", + "description": "the hypervisor version", + "name": "hypervisorversion", + "type": "string" + } + ] + }, + { + "description": "remove an annotation.", + "isasync": false, + "name": "removeAnnotation", + "params": [ + { + "description": "the id of the annotation", + "length": 255, + "name": "id", + "required": true, + "type": "string" + } + ], + "related": "", + "response": [ + { + "description": "the type of the annotated entity", + "name": "entitytype", "type": "string" }, { - "description": "the amount of the host's CPU currently used", - "name": "cpuused", + "description": "the contents of the annotation", + "name": "annotation", "type": "string" }, { - "description": "the amount of the host's memory currently allocated in bytes", - "name": "memoryallocatedbytes", - "type": "long" + "description": "The username of the user that entered the annotation", + "name": "username", + "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 (uu)id of the entitiy to which this annotation pertains", + "name": "entityid", + "type": "string" }, { - "description": "the ID of the host", + "description": "the (uu)id of the annotation", "name": "id", "type": "string" }, { - "description": "the management server ID of the host", - "name": "managementserverid", + "description": "True if the annotation is available for admins only", + "name": "adminsonly", + "type": "boolean" + }, + {}, + {}, + { + "description": "the removal timestamp for this annotation", + "name": "removed", + "type": "date" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "The (uu)id of the user that entered the annotation", + "name": "userid", "type": "string" }, { - "description": "comma-separated list of tags for the host", - "name": "hosttags", + "description": "the name of the entitiy to which this annotation pertains", + "name": "entityname", "type": "string" }, { - "description": "the CPU number of the host", - "name": "cpunumber", - "type": "integer" + "description": "the creation timestamp for this annotation", + "name": "created", + "type": "date" }, - {}, { - "description": "the name of the host", - "name": "name", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" } - ] + ], + "since": "4.11" }, { "description": "Deletes a project role permission in the project", @@ -115592,9 +117196,9 @@ ], "response": [ { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, {}, { @@ -115602,17 +117206,17 @@ "name": "jobstatus", "type": "integer" }, - {}, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" - } + }, + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + }, + {} ], "since": "4.15.0" }, @@ -115631,28 +117235,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": "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" }, @@ -115670,23 +117274,23 @@ } ], "response": [ + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, {}, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, - { - "description": "the 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", @@ -115708,19 +117312,11 @@ "type": "uuid" }, { - "description": "the ID of the containing zone(s) as comma separated string, all for all zones offerings", + "description": "sort key of the VPC offering, integer", "length": 255, - "name": "zoneid", - "required": false, - "since": "4.13", - "type": "string" - }, - { - "description": "the ID of the containing domain(s) as comma separated string, public for public offerings", - "length": 4096, - "name": "domainid", + "name": "sortkey", "required": false, - "type": "string" + "type": "integer" }, { "description": "the display text of the VPC offering", @@ -115730,69 +117326,48 @@ "type": "string" }, { - "description": "the name of the VPC offering", - "length": 255, - "name": "name", + "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": "update state for the VPC offering; supported states - Enabled/Disabled", + "description": "the name of the VPC offering", "length": 255, - "name": "state", + "name": "name", "required": false, "type": "string" }, { - "description": "sort key of the VPC offering, integer", + "description": "the ID of the containing zone(s) as comma separated string, all for all zones offerings", "length": 255, - "name": "sortkey", + "name": "zoneid", "required": false, - "type": "integer" - } - ], - "related": "", - "response": [ - { - "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 domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "domain", - "type": "string" - }, - { - "description": "the id of the vpc offering", - "name": "id", + "since": "4.13", "type": "string" }, { - "description": "an alternate display text of the vpc offering.", - "name": "displaytext", + "description": "update state for the VPC offering; supported states - Enabled/Disabled", + "length": 255, + "name": "state", + "required": false, "type": "string" - }, + } + ], + "related": "", + "response": [ { "description": "state of the vpc offering. Can be Disabled/Enabled", "name": "state", "type": "string" }, { - "description": " indicates if the vpc offering supports distributed router for one-hop forwarding", - "name": "distributedvpcrouter", - "type": "boolean" - }, - { - "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zoneid", + "description": "an alternate display text of the vpc offering.", + "name": "displaytext", "type": "string" }, + {}, { "description": "the list of supported services", "name": "service", @@ -115806,6 +117381,11 @@ "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", @@ -115815,11 +117395,6 @@ "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" @@ -115828,21 +117403,6 @@ "description": "the service provider name", "name": "provider", "response": [ - { - "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" - }, { "description": "state of the network provider", "name": "state", @@ -115862,6 +117422,21 @@ "description": "services for this provider", "name": "servicelist", "type": "list" + }, + { + "description": "the destination physical network", + "name": "destinationphysicalnetworkid", + "type": "string" + }, + { + "description": "the physical network this belongs to", + "name": "physicalnetworkid", + "type": "string" + }, + { + "description": "true if individual services can be enabled/disabled", + "name": "canenableindividualservice", + "type": "boolean" } ], "type": "list" @@ -115869,6 +117444,16 @@ ], "type": "list" }, + { + "description": "true if vpc offering is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": " indicates if the vpc offering supports distributed router for one-hop forwarding", + "name": "distributedvpcrouter", + "type": "boolean" + }, { "description": "the name of the vpc offering", "name": "name", @@ -115880,25 +117465,49 @@ "type": "integer" }, { - "description": " indicated if the offering can support region level vpc", - "name": "supportsregionLevelvpc", - "type": "boolean" + "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "zoneid", + "type": "string" }, { - "description": "the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "domainid", + "description": "the date this vpc offering 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", "type": "string" }, - {}, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, + {}, { - "description": "true if vpc offering is default, false otherwise", - "name": "isdefault", + "description": "the internet protocol of the vpc offering", + "name": "internetprotocol", + "type": "string" + }, + { + "description": "the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "zone", + "type": "string" + }, + { + "description": "the id of the vpc offering", + "name": "id", + "type": "string" + }, + { + "description": "the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "domainid", + "type": "string" + }, + { + "description": " indicated if the offering can support region level vpc", + "name": "supportsregionLevelvpc", "type": "boolean" } ] @@ -115935,26 +117544,16 @@ ], "related": "", "response": [ - { - "description": "the domain id of the account of the remote access vpn", - "name": "domainid", - "type": "string" - }, {}, - { - "description": "is vpn for display to the regular user", - "name": "fordisplay", - "type": "boolean" - }, { "description": "the project name of the vpn", "name": "project", "type": "string" }, { - "description": "the domain name of the account of the remote access vpn", - "name": "domain", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "the UUID of the latest async job acting on this object", @@ -115962,13 +117561,18 @@ "type": "string" }, { - "description": "the ipsec preshared key", - "name": "presharedkey", + "description": "the id of the remote access vpn", + "name": "id", "type": "string" }, { - "description": "the public ip address of the vpn server", - "name": "publicip", + "description": "is vpn for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, + { + "description": "the account of the remote access vpn", + "name": "account", "type": "string" }, { @@ -115977,8 +117581,13 @@ "type": "string" }, { - "description": "the id of the remote access vpn", - "name": "id", + "description": "the domain name of the account of the remote access vpn", + "name": "domain", + "type": "string" + }, + { + "description": "the domain id of the account of the remote access vpn", + "name": "domainid", "type": "string" }, { @@ -115989,17 +117598,17 @@ {}, { "description": "the public ip address of the vpn server", - "name": "publicipid", + "name": "publicip", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the public ip address of the vpn server", + "name": "publicipid", + "type": "string" }, { - "description": "the account of the remote access vpn", - "name": "account", + "description": "the ipsec preshared key", + "name": "presharedkey", "type": "string" }, { @@ -116015,6 +117624,30 @@ "isasync": true, "name": "scaleVirtualMachine", "params": [ + { + "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", + "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": "New maximum number of IOPS for the custom disk offering", + "length": 255, + "name": "maxiops", + "required": false, + "since": "4.17", + "type": "long" + }, { "description": "the ID of the service offering for the virtual machine", "length": 255, @@ -116024,12 +117657,20 @@ "type": "uuid" }, { - "description": "The ID of the virtual machine", + "description": "Flag for automatic migration of the root volume with new compute offering whenever migration is required to apply the offering", "length": 255, - "name": "id", - "related": "destroyVirtualMachine,scaleVirtualMachine,startVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines", - "required": true, - "type": "uuid" + "name": "automigrate", + "required": false, + "since": "4.17", + "type": "boolean" + }, + { + "description": "Verify OK to Shrink", + "length": 255, + "name": "shrinkok", + "required": false, + "since": "4.17", + "type": "boolean" }, { "description": "name value pairs of custom parameters for cpu,memory and cpunumber. example details[i].name=value", @@ -116040,28 +117681,28 @@ } ], "response": [ - {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, + {}, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - {}, - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - } + {} ] }, { @@ -116098,139 +117739,89 @@ "related": "scaleVirtualMachine,startVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines", "response": [ { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "the pool type of the virtual machine", - "name": "pooltype", - "type": "string" - }, - { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", - "type": "string" - }, - { - "description": "the ID of the host for the virtual machine", - "name": "hostid", - "type": "string" - }, - { - "description": "the user's name who deployed the virtual machine", - "name": "username", - "type": "string" - }, - { - "description": "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": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", "type": "boolean" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" - }, - { - "description": "the ID of the disk offering of the virtual machine", - "name": "diskofferingid", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "description": "the incoming network traffic on the vm", - "name": "networkkbsread", - "type": "long" + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" }, { - "description": "the password (if exists) of the virtual machine", - "name": "password", + "description": "Guest vm Boot Mode", + "name": "bootmode", "type": "string" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "the user's ID who deployed the virtual machine", + "name": "userid", "type": "string" }, { - "description": "the internal memory that's free in vm or zero if it can not be calculated", - "name": "memoryintfreekbs", - "type": "long" - }, - { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, { - "description": "the speed of each cpu", - "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 name of the backup offering of the virtual machine", + "name": "backupofferingname", "type": "string" }, { - "description": "State of the Service from LB rule", - "name": "servicestate", + "description": "Os type ID of the virtual machine", + "name": "guestosid", "type": "string" }, { - "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 memory used by the vm", - "name": "memorykbs", - "type": "long" - }, - { - "description": "the name of the virtual machine", - "name": "name", + "description": "the group ID of the virtual machine", + "name": "groupid", "type": "string" }, { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", + "description": "the ID of the host for the virtual machine", + "name": "hostid", "type": "string" }, { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" - }, - { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", - "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 account associated with the virtual machine", + "name": "account", "type": "string" }, { - "description": "the target memory in vm", - "name": "memorytargetkbs", + "description": "the read (IO) of disk on the VM", + "name": "diskioread", "type": "long" }, { @@ -116239,107 +117830,44 @@ "type": "string" }, { - "description": "the list of resource tags associated", - "name": "tags", - "response": [ - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the 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" - } - ], - "type": "set" - }, - { - "description": "the group ID of the virtual machine", - "name": "groupid", - "type": "string" - }, - { - "description": "Os type ID of the virtual machine", - "name": "guestosid", + "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 name of the host for the virtual machine", + "name": "hostname", "type": "string" }, { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" }, { - "description": "the state of the virtual machine", - "name": "state", + "description": "device type of the root volume", + "name": "rootdevicetype", "type": "string" }, { - "description": "ssh key-pair", - "name": "keypair", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" + "description": "the pool type of the virtual machine", + "name": "pooltype", + "type": "string" }, - {}, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "the password (if exists) of the virtual machine", + "name": "password", "type": "string" }, { - "description": "the number of cpu this virtual machine is running with", - "name": "cpunumber", - "type": "integer" + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" }, { "description": "the ID of the backup offering of the virtual machine", @@ -116347,137 +117875,245 @@ "type": "string" }, { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", + "type": "boolean" }, { - "description": "the ID of the availablility zone for the virtual machine", - "name": "zoneid", - "type": "string" + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" }, { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" - }, - { - "description": "the ID of the virtual machine", - "name": "id", + "description": "State of the Service from LB rule", + "name": "servicestate", "type": "string" }, { - "description": "Guest vm Boot Type", - "name": "boottype", + "description": "the project id of the vm", + "name": "projectid", "type": "string" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", - "type": "string" + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" }, { - "description": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", + "description": "the list of resource tags associated", + "name": "tags", "response": [ { - "description": "the description of the affinity group", - "name": "description", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the type of the affinity group", - "name": "type", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the name of the affinity group", - "name": "name", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the domain ID of the affinity group", - "name": "domainid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the domain name of the affinity group", - "name": "domain", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" + "description": "resource type", + "name": "resourcetype", + "type": "string" }, { - "description": "the account owning the affinity group", - "name": "account", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the ID of the affinity group", - "name": "id", + "description": "id of the resource", + "name": "resourceid", "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 project name of the affinity group", - "name": "project", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" } ], "type": "set" }, { - "description": "device type of the root volume", - "name": "rootdevicetype", + "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 ISO attached to the virtual machine", + "name": "isodisplaytext", + "type": "string" }, + {}, { - "description": "the name of the host for the virtual machine", - "name": "hostname", + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", "type": "string" }, { - "description": "the project name of the vm", - "name": "project", + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" + }, + { + "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 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 domain name of the security group", + "name": "domain", + "type": "string" + }, + { + "description": "the name of the security group", + "name": "name", + "type": "string" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the project id of the group", + "name": "projectid", + "type": "string" + }, + { + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" + }, + { + "description": "the domain ID of the security group", + "name": "domainid", + "type": "string" + }, + { + "description": "the project name of the group", + "name": "project", + "type": "string" + }, { "description": "the list of ingress rules associated with the security group", "name": "ingressrule", "response": [ + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, { "description": "the 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", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { @@ -116486,8 +118122,8 @@ "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { @@ -116496,48 +118132,48 @@ "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 project name where tag belongs to", + "name": "project", "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": "tag value", - "name": "value", + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", "type": "string" } ], "type": "set" }, - { - "description": "account owning the security group rule", - "name": "account", - "type": "string" - }, - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, { "description": "the id of the security group rule", "name": "ruleid", "type": "string" }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, { "description": "the CIDR notation for the base IP address of the security group rule", "name": "cidr", @@ -116549,93 +118185,21 @@ "type": "integer" }, { - "description": "security group name", - "name": "securitygroupname", + "description": "account owning the security group rule", + "name": "account", "type": "string" }, - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, { "description": "the type of the ICMP message response", "name": "icmptype", "type": "integer" - }, - { - "description": "the 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 account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "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 project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" } ], "type": "set" }, { - "description": "the domain ID of the security group", - "name": "domainid", + "description": "the account owning the security group", + "name": "account", "type": "string" }, { @@ -116643,18 +118207,13 @@ "name": "id", "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", + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", "type": "string" }, { @@ -116663,57 +118222,57 @@ "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", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "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" }, { @@ -116722,26 +118281,21 @@ "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" } ], "type": "set" }, { - "description": "the protocol of the security group rule", - "name": "protocol", - "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", + "description": "the starting IP of the security group rule", + "name": "startport", "type": "integer" }, { @@ -116750,55 +118304,40 @@ "type": "string" }, { - "description": "the starting IP of the security group rule", - "name": "startport", + "description": "the ending IP of the security group rule ", + "name": "endport", "type": "integer" + }, + { + "description": "the 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 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 description of the security group", "name": "description", "type": "string" }, { - "description": "the account owning the security group", - "name": "account", - "type": "string" - }, - { - "description": "the domain name of the security group", - "name": "domain", - "type": "string" + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" } ], "type": "set" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", + "type": "string" }, { - "description": "the account associated with the virtual machine", - "name": "account", - "type": "string" + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" }, { "description": "the name of the template for the virtual machine", @@ -116806,122 +118345,132 @@ "type": "string" }, { - "description": "the vgpu type used by the virtual machine", - "name": "vgpu", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", "type": "string" }, { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", + "description": "the name of the virtual machine", + "name": "name", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the read (bytes) of disk on the vm", - "name": "diskkbsread", + "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", "type": "long" }, { - "description": "the project id of the vm", - "name": "projectid", - "type": "string" + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" }, { - "description": "the write (io) of disk on the vm", - "name": "diskiowrite", + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", "type": "long" }, { - "description": "the group name of the virtual machine", - "name": "group", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { - "description": "the write (bytes) of disk on the vm", - "name": "diskkbswrite", - "type": "long" - }, - { - "description": "the read (io) of disk on the vm", - "name": "diskioread", - "type": "long" + "description": "Guest vm Boot Type", + "name": "boottype", + "type": "string" }, { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" + "description": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" }, { - "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": "OS type id of the vm", - "name": "ostypeid", - "type": "string" + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" }, { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", - "type": "boolean" + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" }, { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", + "description": "the state of the virtual machine", + "name": "state", "type": "string" }, { "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", + "name": "publicip", "type": "string" }, { - "description": "the 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 list of nics associated with vm", "name": "nic", "response": [ { - "description": "the gateway of the nic", - "name": "gateway", + "description": "the ip address of the nic", + "name": "ipaddress", "type": "string" }, { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" + "description": "the ID of the corresponding network", + "name": "networkid", + "type": "string" }, { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "the netmask of the nic", + "name": "netmask", "type": "string" }, { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "the traffic type of the nic", + "name": "traffictype", "type": "string" }, { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" + }, + { + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "the IPv6 address of network", + "name": "ip6address", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", "type": "string" }, { @@ -116929,49 +118478,59 @@ "name": "type", "type": "string" }, + { + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" + }, { "description": "the ID of the nic", "name": "id", "type": "string" }, { - "description": "the IPv6 address of network", - "name": "ip6address", + "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 Secondary ipv4 addr of nic", - "name": "secondaryip", - "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 VLAN/VNI if available", - "name": "vlanid", - "type": "integer" + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" }, { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" }, { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", "type": "string" }, { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", "type": "string" }, { - "description": "the ip address of the nic", - "name": "ipaddress", + "description": "the name of the corresponding network", + "name": "networkname", "type": "string" }, { @@ -116980,13 +118539,13 @@ "type": "string" }, { - "description": "the netmask of the nic", - "name": "netmask", + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", "type": "string" }, { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "the gateway of the nic", + "name": "gateway", "type": "string" }, { @@ -116995,59 +118554,151 @@ "type": "string" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + } + ], + "type": "set" + }, + { + "description": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" + }, + { + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", + "type": "string" + }, + { + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", + "type": "string" + }, + { + "description": "the group name of the virtual machine", + "name": "group", + "type": "string" + }, + { + "description": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", + "response": [ + { + "description": "the type of the affinity group", + "name": "type", "type": "string" }, { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "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": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "the project name of the affinity group", + "name": "project", + "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the ID of the affinity group", + "name": "id", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "the description of the affinity group", + "name": "description", "type": "string" }, { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", + "description": "the name of the affinity group", + "name": "name", + "type": "string" + }, + { + "description": "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" } ], "type": "set" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", - "type": "string" + "description": "the memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", - "type": "string" + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" }, { - "description": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the ID of the virtual machine", + "name": "id", + "type": "string" }, { "description": "OS name of the vm", "name": "osdisplayname", "type": "string" }, - {} + { + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", + "type": "string" + }, + { + "description": "ssh key-pairs", + "name": "keypairs", + "type": "string" + }, + {}, + { + "description": "OS type id of the vm", + "name": "ostypeid", + "type": "string" + }, + { + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", + "type": "string" + }, + { + "description": "the ID of the disk offering of the virtual machine", + "name": "diskofferingid", + "type": "string" + } ] }, { @@ -117055,14 +118706,6 @@ "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, @@ -117078,54 +118721,26 @@ "related": "", "required": true, "type": "uuid" + }, + { + "description": "an optional field, whether to the display the rule to the end user or not", + "length": 255, + "name": "fordisplay", + "required": false, + "since": "4.4", + "type": "boolean" } ], "related": "", "response": [ { - "description": "the protocol of the firewall rule", - "name": "protocol", - "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 starting port of firewall rule's port range", - "name": "startport", - "type": "integer" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the network id of the firewall rule", - "name": "networkid", + "description": "the cidr list to forward traffic to. Multiple entries are separated by a single comma character (,).", + "name": "destcidrlist", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - {}, - { - "description": "error code for this icmp message", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "the state of the rule", - "name": "state", + "description": "the traffic type for the firewall rule", + "name": "traffictype", "type": "string" }, { @@ -117133,67 +118748,88 @@ "name": "tags", "response": [ { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the project 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 account associated with the tag", - "name": "account", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "customer associated with the tag", + "name": "customer", "type": "string" } ], "type": "list" }, { - "description": "is rule for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "the ID of the firewall rule", + "name": "id", + "type": "string" + }, + { + "description": "the starting port of firewall rule's port range", + "name": "startport", + "type": "integer" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "type of the icmp message being sent", + "name": "icmptype", + "type": "integer" }, {}, + {}, { - "description": "the cidr list to forward traffic to. Multiple entries are separated by a single comma character (,).", - "name": "destcidrlist", + "description": "the public ip address for the firewall rule", + "name": "ipaddress", + "type": "string" + }, + { + "description": "the protocol of the firewall rule", + "name": "protocol", "type": "string" }, { @@ -117201,20 +118837,40 @@ "name": "endport", "type": "integer" }, + { + "description": "the state of the rule", + "name": "state", + "type": "string" + }, + { + "description": "the public ip address id for the firewall rule", + "name": "ipaddressid", + "type": "string" + }, + { + "description": "error code for this icmp message", + "name": "icmpcode", + "type": "integer" + }, { "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", "name": "cidrlist", "type": "string" }, { - "description": "the ID of the firewall rule", - "name": "id", + "description": "the network id of the firewall rule", + "name": "networkid", "type": "string" }, { - "description": "the public ip address id for the firewall rule", - "name": "ipaddressid", - "type": "string" + "description": "the 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" } ], "since": "4.4" @@ -117231,13 +118887,6 @@ "required": false, "type": "integer" }, - { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, { "description": "list os category by name", "length": 255, @@ -117260,10 +118909,18 @@ "name": "keyword", "required": false, "type": "string" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" } ], "related": "", "response": [ + {}, {}, { "description": "the ID of the OS category", @@ -117271,16 +118928,15 @@ "type": "string" }, { - "description": "the name of the OS category", - "name": "name", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the name of the OS category", + "name": "name", "type": "string" }, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", @@ -117294,72 +118950,70 @@ "name": "listServiceOfferings", "params": [ { - "description": "the CPU speed that listed offerings must support", + "description": "name of the service offering", "length": 255, - "name": "cpuspeed", + "name": "name", "required": false, - "since": "4.15", - "type": "integer" + "type": "string" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "page", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { - "description": "the CPU number that listed offerings must support", + "description": "the CPU speed that listed offerings must support", "length": 255, - "name": "cpunumber", + "name": "cpuspeed", "required": false, "since": "4.15", "type": "integer" }, { - "description": "", + "description": "the system VM type. Possible types are \"consoleproxy\", \"secondarystoragevm\" or \"domainrouter\".", "length": 255, - "name": "pagesize", + "name": "systemvmtype", "required": false, - "type": "integer" + "type": "string" }, { - "description": "List by keyword", + "description": "the RAM memory that listed offering must support", "length": 255, - "name": "keyword", + "name": "memory", "required": false, - "type": "string" + "since": "4.15", + "type": "integer" }, { - "description": "id of zone disk offering is associated with", + "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": "zoneid", - "related": "listZones", + "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, - "since": "4.13", "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": "the system VM type. Possible types are \"consoleproxy\", \"secondarystoragevm\" or \"domainrouter\".", + "description": "", "length": 255, - "name": "systemvmtype", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { - "description": "the ID of the virtual machine. Pass this in if you want to see the available service offering that a virtual machine can be changed to.", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "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": "isrecursive", "required": false, - "type": "uuid" + "type": "boolean" }, { "description": "list only resources belonging to the domain specified", @@ -117370,120 +119024,127 @@ "type": "uuid" }, { - "description": "is this a system vm offering", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "issystem", + "name": "listall", "required": false, "type": "boolean" }, { - "description": "ID of the service offering", + "description": "id of zone disk offering is associated with", "length": 255, - "name": "id", - "related": "updateServiceOffering,listServiceOfferings", + "name": "zoneid", + "related": "listZones", "required": false, + "since": "4.13", "type": "uuid" }, { - "description": "the RAM memory that listed offering must support", + "description": "ID of the service offering", "length": 255, - "name": "memory", + "name": "id", + "related": "updateServiceOffering,listServiceOfferings", "required": false, - "since": "4.15", - "type": "integer" + "type": "uuid" }, { - "description": "name of the service offering", + "description": "is this a system vm offering", "length": 255, - "name": "name", + "name": "issystem", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false", + "description": "the CPU number that listed offerings must support", "length": 255, - "name": "listall", + "name": "cpunumber", "required": false, - "type": "boolean" + "since": "4.15", + "type": "integer" } ], "related": "updateServiceOffering", "response": [ { - "description": "is this a default system vm offering", - "name": "defaultuse", - "type": "boolean" + "description": "the max iops of the disk offering", + "name": "maxiops", + "type": "long" }, { - "description": "the storage type for this service offering", - "name": "storagetype", - "type": "string" + "description": "is this a system vm offering", + "name": "issystem", + "type": "boolean" }, { - "description": "provisioning type used to create volumes. Valid values are thin, sparse, fat.", - "name": "provisioningtype", + "description": "the ID of the disk offering to which service offering is linked", + "name": "diskofferingid", "type": "string" }, { - "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": "the memory in MB", - "name": "memory", - "type": "integer" + "description": "the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "domain", + "type": "string" }, { - "description": "the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "domainid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "is true if the offering is customized", + "name": "iscustomized", + "type": "boolean" }, { - "description": "length (in seconds) of the burst", - "name": "diskBytesReadRateMaxLength", + "description": "io requests read rate of the service offering", + "name": "diskIopsReadRate", "type": "long" }, + {}, { - "description": "burst bytes write rate of the disk offering", - "name": "diskBytesWriteRateMax", + "description": "bytes write rate of the service offering", + "name": "diskBytesWriteRate", "type": "long" }, { - "description": "is this a system vm offering", - "name": "issystem", - "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": "data transfer rate in megabits per second allowed.", - "name": "networkrate", + "description": "the number of CPU", + "name": "cpunumber", "type": "integer" }, { - "description": "true if disk offering uses custom iops, false otherwise", - "name": "iscustomizediops", - "type": "boolean" + "description": "the host tag for the service offering", + "name": "hosttags", + "type": "string" }, - {}, { - "description": "io requests write rate of the service offering", - "name": "diskIopsWriteRate", + "description": "is this a the systemvm type for system vm offering", + "name": "systemvmtype", + "type": "string" + }, + { + "description": "Root disk size in GB", + "name": "rootdisksize", "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": "length (in seconds) of the burst", + "name": "diskBytesWriteRateMaxLength", + "type": "long" }, { - "description": "deployment strategy used to deploy VM.", - "name": "deploymentplanner", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "the ha support in the service offering", @@ -117491,14 +119152,14 @@ "type": "boolean" }, { - "description": "the max iops of the disk offering", - "name": "maxiops", - "type": "long" + "description": "true if virtual machine needs to be dynamically scalable of cpu or memory", + "name": "dynamicscalingenabled", + "type": "boolean" }, { - "description": "the date this service offering was created", - "name": "created", - "type": "date" + "description": "data transfer rate in megabits per second allowed.", + "name": "networkrate", + "type": "integer" }, { "description": "the name of the service offering", @@ -117506,150 +119167,165 @@ "type": "string" }, { - "description": "true if virtual machine needs to be dynamically scalable of cpu or memory", - "name": "dynamicscalingenabled", - "type": "boolean" + "description": "deployment strategy used to deploy VM.", + "name": "deploymentplanner", + "type": "string" }, { - "description": "length (in seconds) of the burst", - "name": "diskBytesWriteRateMaxLength", - "type": "long" + "description": "is this a default system vm offering", + "name": "defaultuse", + "type": "boolean" }, { - "description": "Hypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware)", - "name": "hypervisorsnapshotreserve", + "description": "the clock rate CPU speed in Mhz", + "name": "cpuspeed", "type": "integer" }, + {}, + { + "description": "True/False to indicate the strictness of the disk offering association with the compute offering. When set to true, override of disk offering is not allowed when VM is deployed and change disk offering is not allowed for the ROOT disk after the VM is deployed", + "name": "diskofferingstrictness", + "type": "boolean" + }, { "description": "an alternate display text of the service offering.", "name": "displaytext", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "the display text of the disk offering", + "name": "diskofferingdisplaytext", + "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 min iops of the disk offering", - "name": "miniops", + "description": "length (in seconds) of the burst", + "name": "diskBytesReadRateMaxLength", "type": "long" }, - {}, { - "description": "burst io requests write rate of the disk offering", - "name": "diskIopsWriteRateMax", + "description": "length (in seconds) of the burst", + "name": "diskIopsWriteRateMaxLength", "type": "long" }, { - "description": "the cache mode to use for this disk offering. none, writeback or writethrough", - "name": "cacheMode", + "description": "the storage type for this service offering", + "name": "storagetype", "type": "string" }, + { + "description": "burst io requests write rate of the disk offering", + "name": "diskIopsWriteRateMax", + "type": "long" + }, { "description": "the id of the service offering", "name": "id", "type": "string" }, { - "description": "bytes write rate of the service offering", - "name": "diskBytesWriteRate", - "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", + "description": "burst bytes write rate of the disk offering", + "name": "diskBytesWriteRateMax", "type": "long" }, { - "description": "additional key/value details tied with this service offering", - "name": "serviceofferingdetails", - "type": "map" + "description": "burst io requests read rate of the disk offering", + "name": "diskIopsReadRateMax", + "type": "long" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the date this service offering was created", + "name": "created", + "type": "date" }, { - "description": "Root disk size in GB", - "name": "rootdisksize", - "type": "long" + "description": "true if disk offering uses custom iops, false otherwise", + "name": "iscustomizediops", + "type": "boolean" }, { - "description": "io requests read rate of the service offering", - "name": "diskIopsReadRate", + "description": "bytes read rate of the service offering", + "name": "diskBytesReadRate", "type": "long" }, { - "description": "the tags for the service offering", - "name": "storagetags", + "description": "provisioning type used to create volumes. Valid values are thin, sparse, fat.", + "name": "provisioningtype", "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 cache mode to use for this disk offering. none, writeback or writethrough", + "name": "cacheMode", "type": "string" }, { - "description": "is true if the offering is customized", - "name": "iscustomized", - "type": "boolean" - }, - { - "description": "the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zone", + "description": "name of the disk offering", + "name": "diskofferingname", "type": "string" }, { - "description": "restrict the CPU usage to committed service offering", - "name": "limitcpuuse", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "the host tag for the service offering", - "name": "hosttags", - "type": "string" + "description": "burst bytes read rate of the disk offering", + "name": "diskBytesReadRateMax", + "type": "long" }, { - "description": "bytes read rate of the service offering", - "name": "diskBytesReadRate", + "description": "length (in second) of the burst", + "name": "diskIopsReadRateMaxLength", "type": "long" }, { - "description": "burst bytes read rate of the disk offering", - "name": "diskBytesReadRateMax", - "type": "long" + "description": "the memory in MB", + "name": "memory", + "type": "integer" }, { - "description": "the vsphere storage policy tagged to the service offering in case of VMware", - "name": "vspherestoragepolicy", + "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "zoneid", "type": "string" }, { - "description": "is this a the systemvm type for system vm offering", - "name": "systemvmtype", + "description": "the tags for the service offering", + "name": "storagetags", "type": "string" }, { - "description": "the number of CPU", - "name": "cpunumber", - "type": "integer" + "description": "restrict the CPU usage to committed service offering", + "name": "limitcpuuse", + "type": "boolean" }, { - "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zoneid", - "type": "string" + "description": "io requests write rate of the service offering", + "name": "diskIopsWriteRate", + "type": "long" }, { - "description": "the clock rate CPU speed in Mhz", - "name": "cpuspeed", + "description": "the min iops of the disk offering", + "name": "miniops", + "type": "long" + }, + { + "description": "Hypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware)", + "name": "hypervisorsnapshotreserve", "type": "integer" }, { - "description": "burst io requests read rate of the disk offering", - "name": "diskIopsReadRateMax", - "type": "long" + "description": "the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "domainid", + "type": "string" } ] }, @@ -117659,7 +119335,7 @@ "name": "removeFromGlobalLoadBalancerRule", "params": [ { - "description": "the list load balancer rules that will be assigned to gloabal load balancer rule", + "description": "the list load balancer rules that will be assigned to global load balancer rule", "length": 255, "name": "loadbalancerrulelist", "related": "", @@ -117676,17 +119352,11 @@ } ], "response": [ - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, {}, { "description": "the current status of the latest async job acting on this object", @@ -117694,10 +119364,16 @@ "type": "integer" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" - } + }, + {} ] }, { @@ -117708,7 +119384,7 @@ { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, @@ -117722,85 +119398,59 @@ { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" } ], "related": "", "response": [ - {}, - {}, { - "description": "the type of the affinity group", - "name": "type", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the type of the affinity group", + "name": "type", + "type": "string" } ] }, { - "description": "Assigns a VM to a backup offering", - "isasync": true, - "name": "assignVirtualMachineToBackupOffering", + "description": "Lists all the system wide capacities.", + "isasync": false, + "name": "listCapacity", "params": [ { - "description": "ID of the virtual machine", - "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": true, - "type": "uuid" - }, - { - "description": "ID of the backup offering", + "description": "Sort the results. Available values: Usage", "length": 255, - "name": "backupofferingid", - "related": "", - "required": true, - "type": "uuid" - } - ], - "response": [ - { - "description": "any text associated with the success or failure", - "name": "displaytext", + "name": "sortby", + "required": false, + "since": "3.0.0", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "lists capacity by type* CAPACITY_TYPE_MEMORY = 0* CAPACITY_TYPE_CPU = 1* CAPACITY_TYPE_STORAGE = 2* CAPACITY_TYPE_STORAGE_ALLOCATED = 3* CAPACITY_TYPE_VIRTUAL_NETWORK_PUBLIC_IP = 4* CAPACITY_TYPE_PRIVATE_IP = 5* CAPACITY_TYPE_SECONDARY_STORAGE = 6* CAPACITY_TYPE_VLAN = 7* CAPACITY_TYPE_DIRECT_ATTACHED_PUBLIC_IP = 8* CAPACITY_TYPE_LOCAL_STORAGE = 9* CAPACITY_TYPE_GPU = 19* CAPACITY_TYPE_CPU_CORE = 90.", + "length": 255, + "name": "type", + "required": false, "type": "integer" }, { - "description": "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": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, - {} - ], - "since": "4.14.0" - }, - { - "description": "Lists all the system wide capacities.", - "isasync": false, - "name": "listCapacity", - "params": [ { "description": "", "length": 255, @@ -117832,20 +119482,6 @@ "since": "3.0.0", "type": "uuid" }, - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - }, - { - "description": "lists capacity by type* CAPACITY_TYPE_MEMORY = 0* CAPACITY_TYPE_CPU = 1* CAPACITY_TYPE_STORAGE = 2* CAPACITY_TYPE_STORAGE_ALLOCATED = 3* CAPACITY_TYPE_VIRTUAL_NETWORK_PUBLIC_IP = 4* CAPACITY_TYPE_PRIVATE_IP = 5* CAPACITY_TYPE_SECONDARY_STORAGE = 6* CAPACITY_TYPE_VLAN = 7* CAPACITY_TYPE_DIRECT_ATTACHED_PUBLIC_IP = 8* CAPACITY_TYPE_LOCAL_STORAGE = 9* CAPACITY_TYPE_GPU = 19* CAPACITY_TYPE_CPU_CORE = 90.", - "length": 255, - "name": "type", - "required": false, - "type": "integer" - }, { "description": "recalculate capacities and fetch the latest", "length": 255, @@ -117854,14 +119490,6 @@ "since": "3.0.0", "type": "boolean" }, - { - "description": "Sort the results. Available values: Usage", - "length": 255, - "name": "sortby", - "required": false, - "since": "3.0.0", - "type": "string" - }, { "description": "lists capacity by the Pod ID", "length": 255, @@ -117873,52 +119501,6 @@ ], "related": "", "response": [ - { - "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" - }, - { - "description": "the Pod ID", - "name": "podid", - "type": "string" - }, - { - "description": "the capacity currently in use", - "name": "capacityused", - "type": "long" - }, - { - "description": "the Zone name", - "name": "zonename", - "type": "string" - }, - {}, - { - "description": "the Cluster name", - "name": "clustername", - "type": "string" - }, - { - "description": "the percentage of capacity currently in use", - "name": "percentused", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "the Cluster ID", "name": "clusterid", @@ -117930,389 +119512,140 @@ "type": "short" }, { - "description": "the Zone ID", - "name": "zoneid", - "type": "string" - }, - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the capacity name", - "name": "name", - "type": "string" - } - ] - }, - { - "description": "Starts a virtual machine.", - "isasync": true, - "name": "startVirtualMachine", - "params": [ - { - "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": "destination Cluster ID to deploy the VM to - parameter available for root admin only", - "length": 255, - "name": "clusterid", - "related": "", - "required": false, - "type": "uuid" - }, - { - "description": "destination Pod ID to deploy the VM to - parameter available for root admin only", - "length": 255, - "name": "podid", - "related": "", - "required": false, - "type": "uuid" - }, - { - "description": "The ID of the virtual machine", - "length": 255, - "name": "id", - "related": "scaleVirtualMachine,startVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines", - "required": true, - "type": "uuid" - }, - { - "description": "destination Host ID to deploy the VM to - parameter available for root admin only", - "length": 255, - "name": "hostid", - "related": "", - "required": false, - "since": "3.0.1", - "type": "uuid" - }, - { - "description": "Boot into hardware setup menu or not", - "length": 255, - "name": "bootintosetup", - "required": false, - "since": "4.15.0.0", - "type": "boolean" - } - ], - "related": "scaleVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines", - "response": [ - {}, - { - "description": "the list of resource tags associated", - "name": "tags", - "response": [ - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", - "type": "string" - }, - { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", - "type": "string" - }, - {}, - { - "description": "the outgoing network traffic on the host", - "name": "networkkbswrite", - "type": "long" - }, - { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", + "description": "the capacity currently in allocated", + "name": "capacityallocated", "type": "long" }, { - "description": "the user's name who deployed the virtual machine", - "name": "username", + "description": "the Zone name", + "name": "zonename", "type": "string" }, { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" + "description": "the Zone ID", + "name": "zoneid", + "type": "string" }, + {}, { - "description": "the memory used by the vm", - "name": "memorykbs", - "type": "long" + "description": "the Cluster name", + "name": "clustername", + "type": "string" }, { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" + "description": "the Pod name", + "name": "podname", + "type": "string" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", + "description": "the capacity name", + "name": "name", "type": "string" }, { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", + "description": "the percentage of capacity currently in use", + "name": "percentused", "type": "string" }, { - "description": "the write (bytes) of disk on the vm", - "name": "diskkbswrite", - "type": "long" + "description": "the Pod ID", + "name": "podid", + "type": "string" }, { - "description": "the target memory in vm", - "name": "memorytargetkbs", + "description": "the total capacity available", + "name": "capacitytotal", "type": "long" }, { - "description": "the write (io) of disk on the vm", - "name": "diskiowrite", + "description": "the capacity currently in use", + "name": "capacityused", "type": "long" }, { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "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": "the type of the nic", - "name": "type", - "type": "string" - }, - { - "description": "the IPv6 address of network", - "name": "ip6address", - "type": "string" - }, - { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" - }, - { - "description": "the ip address of the nic", - "name": "ipaddress", - "type": "string" - }, - { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", - "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 isolation uri of the nic", - "name": "isolationuri", - "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": "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": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" - }, - { - "description": "Type of adapter if available", - "name": "adaptertype", - "type": "string" - }, - { - "description": "the ID of the corresponding network", - "name": "networkid", - "type": "string" - }, - { - "description": "the name of the corresponding network", - "name": "networkname", - "type": "string" - }, - { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" - }, - { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", - "type": "string" - }, - { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - }, - { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", - "type": "string" - }, - { - "description": "the ID of the nic", - "name": "id", - "type": "string" - }, - { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", - "type": "string" - }, - { - "description": "the netmask of the nic", - "name": "netmask", - "type": "string" - } - ], - "type": "set" - }, + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + } + ] + }, + { + "description": "Starts a virtual machine.", + "isasync": true, + "name": "startVirtualMachine", + "params": [ { - "description": "the project name of the vm", - "name": "project", + "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 name of the availability zone for the virtual machine", - "name": "zonename", - "type": "string" + "description": "Boot into hardware setup menu or not", + "length": 255, + "name": "bootintosetup", + "required": false, + "since": "4.15.0.0", + "type": "boolean" }, { - "description": "the password (if exists) of the virtual machine", - "name": "password", - "type": "string" + "description": "destination Cluster ID to deploy the VM to - parameter available for root admin only", + "length": 255, + "name": "clusterid", + "related": "", + "required": false, + "type": "uuid" }, { - "description": "the speed of each cpu", - "name": "cpuspeed", - "type": "integer" + "description": "The ID of the virtual machine", + "length": 255, + "name": "id", + "related": "scaleVirtualMachine,startVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines", + "required": true, + "type": "uuid" }, { - "description": "the state of the virtual machine", - "name": "state", - "type": "string" + "description": "destination Pod ID to deploy the VM to - parameter available for root admin only", + "length": 255, + "name": "podid", + "related": "", + "required": false, + "type": "uuid" }, { - "description": "the ID of the availablility zone for the virtual machine", - "name": "zoneid", + "description": "destination Host ID to deploy the VM to - parameter available for root admin only", + "length": 255, + "name": "hostid", + "related": "", + "required": false, + "since": "3.0.1", + "type": "uuid" + } + ], + "related": "scaleVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines", + "response": [ + { + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the name of the disk offering of the virtual machine", + "name": "diskofferingname", "type": "string" }, + {}, { - "description": "ssh key-pair", - "name": "keypair", + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", "type": "string" }, { @@ -118321,88 +119654,72 @@ "type": "string" }, { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" + "description": "the group ID of the virtual machine", + "name": "groupid", + "type": "string" }, { - "description": "the internal memory that's free in vm or zero if it can not be calculated", - "name": "memoryintfreekbs", - "type": "long" + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "the name of the virtual machine", + "name": "name", "type": "string" }, { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", - "type": "boolean" + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" }, { - "description": "Guest vm Boot Type", - "name": "boottype", - "type": "string" + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" }, { - "description": "the ID of the virtual machine", - "name": "id", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "description": "device ID of the root volume", - "name": "rootdeviceid", + "description": "the VM's disk read in KiB", + "name": "diskkbsread", "type": "long" }, - { - "description": "the vgpu type used by the virtual machine", - "name": "vgpu", - "type": "string" - }, { "description": "the name of the backup offering of the virtual machine", "name": "backupofferingname", "type": "string" }, { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", - "type": "string" - }, - { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", - "type": "string" - }, - { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" - }, - { - "description": "the account associated with the virtual machine", - "name": "account", - "type": "string" + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" }, - {}, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", - "type": "string" + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", - "type": "string" + "description": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" }, { "description": "list of security groups associated with the virtual machine", "name": "securitygroup", "response": [ { - "description": "the project id of the group", - "name": "projectid", + "description": "the description of the security group", + "name": "description", + "type": "string" + }, + { + "description": "the domain name of the security group", + "name": "domain", "type": "string" }, { @@ -118410,23 +119727,23 @@ "name": "tags", "response": [ { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "customer associated with the tag", + "name": "customer", "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": "id of the resource", + "name": "resourceid", "type": "string" }, { @@ -118435,46 +119752,36 @@ "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "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" } ], "type": "set" }, { - "description": "the project name of the group", - "name": "project", - "type": "string" - }, - { - "description": "the domain name of the security group", - "name": "domain", - "type": "string" - }, - { - "description": "the description of the security group", - "name": "description", + "description": "the account owning the security group", + "name": "account", "type": "string" }, { @@ -118483,51 +119790,61 @@ "type": "string" }, { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" + "description": "the name of the security group", + "name": "name", + "type": "string" }, { - "description": "the list of 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 ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, { "description": "tag key name", "name": "key", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "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": "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" }, { @@ -118536,22 +119853,32 @@ "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", "type": "string" } ], "type": "set" }, { - "description": "the 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 protocol of the security group rule", @@ -118572,68 +119899,28 @@ "description": "account owning the security group rule", "name": "account", "type": "string" - }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "the 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 number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" - }, - { - "description": "the name of the security group", - "name": "name", - "type": "string" - }, - { - "description": "the domain ID of the security group", - "name": "domainid", - "type": "string" - }, - { - "description": "the account owning the security group", - "name": "account", - "type": "string" - }, - { - "description": "the list of ingress rules associated with the security group", - "name": "ingressrule", + "description": "the list of egress rules associated with the security group", + "name": "egressrule", "response": [ { - "description": "the 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", + "description": "the type of the ICMP message response", + "name": "icmptype", "type": "integer" }, { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" + "description": "account owning the security group rule", + "name": "account", + "type": "string" }, { "description": "the CIDR notation for the base IP address of the security group rule", @@ -118641,29 +119928,24 @@ "type": "string" }, { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" }, { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ - { - "description": "the 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", @@ -118680,13 +119962,13 @@ "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { @@ -118695,8 +119977,18 @@ "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { @@ -118708,59 +120000,94 @@ "type": "set" }, { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" }, { "description": "security group name", "name": "securitygroupname", "type": "string" - }, - { - "description": "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 number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" + }, + { + "description": "the project name of the group", + "name": "project", + "type": "string" + }, + { + "description": "the domain ID of the security group", + "name": "domainid", + "type": "string" + }, + { + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" } ], "type": "set" }, { - "description": "the incoming network traffic on the vm", - "name": "networkkbsread", - "type": "long" + "description": "the project name of the vm", + "name": "project", + "type": "string" }, { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", + "type": "string" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", + "description": "the ID of the availablility zone for the virtual machine", + "name": "zoneid", + "type": "string" + }, + { + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", + "type": "string" + }, + { + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", "type": "long" }, { - "description": "the pool type of the virtual machine", - "name": "pooltype", + "description": "the name of the host for the virtual machine", + "name": "hostname", "type": "string" }, { - "description": "OS type id of the vm", - "name": "ostypeid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "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 ID of the domain in which the virtual machine exists", - "name": "domainid", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { @@ -118769,69 +120096,105 @@ "type": "string" }, { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", - "type": "boolean" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the name of the virtual machine", - "name": "name", + "description": "Guest vm Boot Type", + "name": "boottype", "type": "string" }, { - "description": "device type of the root volume", - "name": "rootdevicetype", - "type": "string" + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" }, { - "description": "the group ID of the virtual machine", - "name": "groupid", + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", "type": "string" }, { - "description": "the read (io) of disk on the vm", - "name": "diskioread", + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", "type": "long" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "Os type ID of the virtual machine", + "name": "guestosid", "type": "string" }, { - "description": "the name of the host for the virtual machine", - "name": "hostname", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, + {}, { "description": "the name of the service offering of the virtual machine", "name": "serviceofferingname", "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", + "description": "OS type id of the vm", + "name": "ostypeid", "type": "string" }, { - "description": "State of the Service from LB rule", - "name": "servicestate", + "description": "the account associated with the virtual machine", + "name": "account", + "type": "string" + }, + { + "description": "the pool type of the virtual machine", + "name": "pooltype", + "type": "string" + }, + { + "description": "the ID of the virtual machine", + "name": "id", + "type": "string" + }, + { + "description": "Guest vm Boot Mode", + "name": "bootmode", + "type": "string" + }, + { + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" + }, + { + "description": "the memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" + }, + { + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", "type": "string" }, { "description": "list of affinity groups associated with the virtual machine", "name": "affinitygroup", "response": [ + { + "description": "the ID of the affinity group", + "name": "id", + "type": "string" + }, + { + "description": "the name of the affinity group", + "name": "name", + "type": "string" + }, { "description": "virtual machine IDs associated with this affinity group", "name": "virtualmachineIds", @@ -118843,117 +120206,392 @@ "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 project name of the affinity group", + "name": "project", + "type": "string" + }, + { + "description": "the account owning the affinity group", + "name": "account", + "type": "string" + }, + { + "description": "the type of the affinity group", + "name": "type", + "type": "string" + }, + { + "description": "the description of the affinity group", + "name": "description", + "type": "string" + }, + { + "description": "the domain ID of the affinity group", + "name": "domainid", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" + }, + { + "description": "State of the Service from LB rule", + "name": "servicestate", + "type": "string" + }, + { + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" + }, + { + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" + }, + { + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" + }, + { + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", + "type": "string" + }, + { + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", + "type": "string" + }, + { + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", + "type": "string" + }, + { + "description": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" + }, + { + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" + }, + { + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", + "type": "string" + }, + { + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", + "type": "boolean" + }, + { + "description": "OS name of the vm", + "name": "osdisplayname", + "type": "string" + }, + { + "description": "the ID of the disk offering of the virtual machine", + "name": "diskofferingid", + "type": "string" + }, + { + "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", + "type": "long" + }, + { + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", + "type": "string" + }, + { + "description": "the list of nics associated with vm", + "name": "nic", + "response": [ + { + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" + }, + { + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", + "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 isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "the gateway of the nic", + "name": "gateway", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "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": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "the ID of the corresponding network", + "name": "networkid", + "type": "string" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + }, + { + "description": "the isolation uri of the nic", + "name": "isolationuri", + "type": "string" + }, + { + "description": "the name of the corresponding network", + "name": "networkname", + "type": "string" + }, + { + "description": "the IPv6 address of network", + "name": "ip6address", + "type": "string" + }, + { + "description": "the 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": "true if nic is default, false otherwise", + "name": "macaddress", + "type": "string" + }, + { + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "the traffic type of the nic", + "name": "traffictype", "type": "string" }, { - "description": "the name of the affinity group", - "name": "name", + "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 type of the nic", + "name": "type", "type": "string" }, { - "description": "the account owning the affinity group", - "name": "account", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "the type of the affinity group", - "name": "type", + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", "type": "string" }, { - "description": "the ID of the affinity group", - "name": "id", + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "type": "string" }, { - "description": "the domain ID of the affinity group", - "name": "domainid", + "description": "the ip address of the nic", + "name": "ipaddress", "type": "string" }, { - "description": "the domain name of the affinity group", - "name": "domain", + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" } ], "type": "set" }, { - "description": "the group name of the virtual machine", - "name": "group", - "type": "string" - }, - { - "description": "OS name of the vm", - "name": "osdisplayname", - "type": "string" - }, - { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" }, { - "description": "the ID of the disk offering of the virtual machine", - "name": "diskofferingid", - "type": "string" + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" }, { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", - "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 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": "Os type ID of the virtual machine", - "name": "guestosid", + "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 amount of the vm's CPU currently used", + "name": "cpuused", "type": "string" }, { - "description": "the name of the disk offering of the virtual machine", - "name": "diskofferingname", + "description": "ssh key-pairs", + "name": "keypairs", "type": "string" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "device type of the root volume", + "name": "rootdevicetype", "type": "string" }, { - "description": "the number of cpu this virtual machine is running with", - "name": "cpunumber", + "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 group name of the virtual machine", + "name": "group", + "type": "string" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "the password (if exists) of the virtual machine", + "name": "password", "type": "string" }, { - "description": "the read (bytes) of disk on the vm", - "name": "diskkbsread", - "type": "long" + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", + "type": "string" } ] }, @@ -118963,42 +120601,41 @@ "name": "updateServiceOffering", "params": [ { - "description": "the ID of the service offering to be updated", + "description": "sort key of the service offering, integer", "length": 255, - "name": "id", - "related": "updateServiceOffering", - "required": true, - "type": "uuid" + "name": "sortkey", + "required": false, + "type": "integer" }, { - "description": "the display text of the service offering to be updated", + "description": "the name of the service offering to be updated", "length": 255, - "name": "displaytext", + "name": "name", "required": false, "type": "string" }, { - "description": "the host tag for this service offering.", + "description": "comma-separated list of tags for the service offering, tags should match with existing storage pool tags", "length": 255, - "name": "hosttags", + "name": "storagetags", "required": false, "since": "4.16", "type": "string" }, { - "description": "the name of the service offering to be updated", + "description": "the display text of the service offering to be updated", "length": 255, - "name": "name", + "name": "displaytext", "required": false, "type": "string" }, { - "description": "comma-separated list of tags for the service offering, tags should match with existing storage pool tags", + "description": "the ID of the service offering to be updated", "length": 255, - "name": "storagetags", - "required": false, - "since": "4.16", - "type": "string" + "name": "id", + "related": "updateServiceOffering", + "required": true, + "type": "uuid" }, { "description": "the ID of the containing zone(s) as comma separated string, all for all zones offerings", @@ -119009,90 +120646,142 @@ "type": "string" }, { - "description": "the ID of the containing domain(s) as comma separated string, public for public offerings", - "length": 4096, - "name": "domainid", + "description": "the host tag for this service offering.", + "length": 255, + "name": "hosttags", "required": false, + "since": "4.16", "type": "string" }, { - "description": "sort key of the service offering, integer", - "length": 255, - "name": "sortkey", + "description": "the ID of the containing domain(s) as comma separated string, public for public offerings", + "length": 4096, + "name": "domainid", "required": false, - "type": "integer" + "type": "string" } ], "related": "", "response": [ { - "description": "additional key/value details tied with this service offering", - "name": "serviceofferingdetails", - "type": "map" + "description": "data transfer rate in megabits per second allowed.", + "name": "networkrate", + "type": "integer" }, { - "description": "is this a the systemvm type for system vm offering", - "name": "systemvmtype", + "description": "length (in seconds) of the burst", + "name": "diskIopsWriteRateMaxLength", + "type": "long" + }, + { + "description": "the ha support in the service offering", + "name": "offerha", + "type": "boolean" + }, + { + "description": "name of the disk offering", + "name": "diskofferingname", "type": "string" }, { - "description": "the min iops of the disk offering", - "name": "miniops", + "description": "is this a system vm offering", + "name": "issystem", + "type": "boolean" + }, + {}, + { + "description": "bytes write rate of the service offering", + "name": "diskBytesWriteRate", "type": "long" }, { - "description": "the storage type for this service offering", - "name": "storagetype", + "description": "the host tag for the service offering", + "name": "hosttags", "type": "string" }, { - "description": "burst io requests read rate of the disk offering", - "name": "diskIopsReadRateMax", + "description": "Root disk size in GB", + "name": "rootdisksize", "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 if virtual machine needs to be dynamically scalable of cpu or memory", "name": "dynamicscalingenabled", "type": "boolean" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "Hypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware)", + "name": "hypervisorsnapshotreserve", + "type": "integer" }, { - "description": "restrict the CPU usage to committed service offering", - "name": "limitcpuuse", + "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": "deployment strategy used to deploy VM.", + "name": "deploymentplanner", + "type": "string" + }, + { + "description": "the id of the service offering", + "name": "id", + "type": "string" + }, + { + "description": "length (in seconds) of the burst", + "name": "diskBytesReadRateMaxLength", + "type": "long" + }, + { + "description": "length (in seconds) of the burst", + "name": "diskBytesWriteRateMaxLength", + "type": "long" + }, + { + "description": "io requests write rate of the service offering", + "name": "diskIopsWriteRate", + "type": "long" + }, { "description": "length (in second) of the burst", "name": "diskIopsReadRateMaxLength", "type": "long" }, { - "description": "data transfer rate in megabits per second allowed.", - "name": "networkrate", - "type": "integer" + "description": "burst bytes write rate of the disk offering", + "name": "diskBytesWriteRateMax", + "type": "long" }, { - "description": "the vsphere storage policy tagged to the service offering in case of VMware", - "name": "vspherestoragepolicy", + "description": "provisioning type used to create volumes. Valid values are thin, sparse, fat.", + "name": "provisioningtype", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "the memory in MB", + "name": "memory", "type": "integer" }, { - "description": "is true if the offering is customized", - "name": "iscustomized", - "type": "boolean" + "description": "burst io requests read rate of the disk offering", + "name": "diskIopsReadRateMax", + "type": "long" }, { - "description": "the name of the service offering", - "name": "name", + "description": "the tags for the service offering", + "name": "storagetags", "type": "string" }, { @@ -119101,19 +120790,24 @@ "type": "string" }, { - "description": "is this a system vm offering", - "name": "issystem", - "type": "boolean" + "description": "the ID of the disk offering to which service offering is linked", + "name": "diskofferingid", + "type": "string" }, { - "description": "the memory in MB", - "name": "memory", - "type": "integer" + "description": "an alternate display text of the service offering.", + "name": "displaytext", + "type": "string" }, { - "description": "Root disk size in GB", - "name": "rootdisksize", - "type": "long" + "description": "the date this service offering was created", + "name": "created", + "type": "date" + }, + { + "description": "additional key/value details tied with this service offering", + "name": "serviceofferingdetails", + "type": "map" }, { "description": "the max iops of the disk offering", @@ -119121,24 +120815,44 @@ "type": "long" }, { - "description": "the host tag for the service offering", - "name": "hosttags", + "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/False to indicate the strictness of the disk offering association with the compute offering. When set to true, override of disk offering is not allowed when VM is deployed and change disk offering is not allowed for the ROOT disk after the VM is deployed", + "name": "diskofferingstrictness", + "type": "boolean" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "true if disk offering uses custom iops, false otherwise", + "name": "iscustomizediops", + "type": "boolean" + }, + { + "description": "is true if the offering is customized", + "name": "iscustomized", + "type": "boolean" + }, { "description": "io requests read rate of the service offering", "name": "diskIopsReadRate", "type": "long" }, { - "description": "deployment strategy used to deploy VM.", - "name": "deploymentplanner", - "type": "string" + "description": "burst io requests write rate of the disk offering", + "name": "diskIopsWriteRateMax", + "type": "long" }, { - "description": "io requests write rate of the service offering", - "name": "diskIopsWriteRate", - "type": "long" + "description": "is this a default system vm offering", + "name": "defaultuse", + "type": "boolean" }, { "description": "the cache mode to use for this disk offering. none, writeback or writethrough", @@ -119146,24 +120860,45 @@ "type": "string" }, { - "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": "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": "the name of the service offering", + "name": "name", + "type": "string" + }, + { + "description": "restrict the CPU usage to committed service offering", + "name": "limitcpuuse", "type": "boolean" }, + { + "description": "the min iops of the disk offering", + "name": "miniops", + "type": "long" + }, + { + "description": "is this a the systemvm type for system vm offering", + "name": "systemvmtype", + "type": "string" + }, { "description": "bytes read rate of the service offering", "name": "diskBytesReadRate", "type": "long" }, + {}, { - "description": "burst bytes read rate of the disk offering", - "name": "diskBytesReadRateMax", - "type": "long" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "domainid", + "type": "string" }, { "description": "the number of CPU", @@ -119171,242 +120906,267 @@ "type": "integer" }, { - "description": "length (in seconds) of the burst", - "name": "diskBytesReadRateMaxLength", + "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": "Hypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware)", - "name": "hypervisorsnapshotreserve", - "type": "integer" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "burst bytes write rate of the disk offering", - "name": "diskBytesWriteRateMax", - "type": "long" + "description": "the display text of the disk offering", + "name": "diskofferingdisplaytext", + "type": "string" + } + ] + }, + { + "description": "Stops a virtual machine.", + "isasync": true, + "name": "stopVirtualMachine", + "params": [ + { + "description": "The ID of the virtual machine", + "length": 255, + "name": "id", + "related": "scaleVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines", + "required": true, + "type": "uuid" }, + { + "description": "Force stop the VM (vm is marked as Stopped even when command fails to be send to the backend, otherwise a force poweroff is attempted). The caller knows the VM is stopped.", + "length": 255, + "name": "forced", + "required": false, + "type": "boolean" + } + ], + "related": "scaleVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines", + "response": [ {}, { - "description": "length (in seconds) of the burst", - "name": "diskBytesWriteRateMaxLength", + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", "type": "long" }, { - "description": "bytes write rate of the service offering", - "name": "diskBytesWriteRate", - "type": "long" + "description": "device type of the root volume", + "name": "rootdevicetype", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "description": "is this a default system vm offering", - "name": "defaultuse", + "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": "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": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "domain", + "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": "burst io requests write rate of the disk offering", - "name": "diskIopsWriteRateMax", - "type": "long" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, - {}, { - "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 outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" }, { - "description": "the clock rate CPU speed in Mhz", - "name": "cpuspeed", - "type": "integer" + "description": "the read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" }, { - "description": "true if disk offering uses custom iops, false otherwise", - "name": "iscustomizediops", + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", "type": "boolean" }, { - "description": "the ha support in the service offering", - "name": "offerha", + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", "type": "boolean" }, { - "description": "the id of the service offering", - "name": "id", + "description": "the account associated with the virtual machine", + "name": "account", + "type": "string" + }, + { + "description": "the memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" + }, + { + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" + }, + { + "description": "the pool type of the virtual machine", + "name": "pooltype", "type": "string" }, { - "description": "the date this service offering was created", - "name": "created", - "type": "date" + "description": "OS name of the vm", + "name": "osdisplayname", + "type": "string" }, { - "description": "provisioning type used to create volumes. Valid values are thin, sparse, fat.", - "name": "provisioningtype", + "description": "the project name of the vm", + "name": "project", "type": "string" }, { - "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zoneid", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { - "description": "an alternate display text of the service offering.", - "name": "displaytext", + "description": "the user's ID who deployed the virtual machine", + "name": "userid", "type": "string" }, { - "description": "the tags for the service offering", - "name": "storagetags", + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", "type": "string" - } - ] - }, - { - "description": "Stops a virtual machine.", - "isasync": true, - "name": "stopVirtualMachine", - "params": [ - { - "description": "The ID of the virtual machine", - "length": 255, - "name": "id", - "related": "scaleVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines", - "required": true, - "type": "uuid" }, { - "description": "Force stop the VM (vm is marked as Stopped even when command fails to be send to the backend, otherwise a force poweroff is attempted). The caller knows the VM is stopped.", - "length": 255, - "name": "forced", - "required": false, + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", "type": "boolean" - } - ], - "related": "scaleVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines", - "response": [ + }, { - "description": "OS type id of the vm", - "name": "ostypeid", + "description": "the ID of the availablility zone for the virtual machine", + "name": "zoneid", "type": "string" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "the user's name who deployed the virtual machine", + "name": "username", "type": "string" }, + {}, + { + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" + }, { "description": "list of security groups associated with the virtual machine", "name": "securitygroup", "response": [ - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "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 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 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 domain ID of the security group", - "name": "domainid", + "description": "the project id of the group", + "name": "projectid", "type": "string" }, { "description": "the list of egress rules associated with the security group", "name": "egressrule", "response": [ + { + "description": "the 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", @@ -119417,8 +121177,8 @@ "name": "tags", "response": [ { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "tag value", + "name": "value", "type": "string" }, { @@ -119427,33 +121187,33 @@ "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { @@ -119462,33 +121222,18 @@ "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the account associated with the tag", + "name": "account", "type": "string" } ], "type": "set" }, { - "description": "the id of the 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", + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", "type": "string" }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, { "description": "security group name", "name": "securitygroupname", @@ -119500,27 +121245,32 @@ "type": "string" }, { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", + "description": "the id of the security group rule", + "name": "ruleid", "type": "string" }, { "description": "the type of the ICMP message response", "name": "icmptype", "type": "integer" + }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" } ], "type": "set" }, { - "description": "the ID of the security group", - "name": "id", - "type": "string" + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" }, { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" + "description": "the description of the security group", + "name": "description", + "type": "string" }, { "description": "the list of ingress rules associated with the security group", @@ -119532,38 +121282,38 @@ "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 type of the ICMP message response", + "name": "icmptype", + "type": "integer" }, { - "description": "the code for the ICMP message response", - "name": "icmpcode", + "description": "the starting IP of the security group rule", + "name": "startport", "type": "integer" }, { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" + "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" }, { - "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", + "description": "the ending IP of the security group rule ", + "name": "endport", "type": "integer" }, { @@ -119571,13 +121321,18 @@ "name": "tags", "response": [ { - "description": "the domain associated with the tag", - "name": "domain", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { @@ -119586,13 +121341,13 @@ "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { @@ -119610,11 +121365,6 @@ "name": "project", "type": "string" }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, { "description": "tag key name", "name": "key", @@ -119624,160 +121374,101 @@ "type": "set" }, { - "description": "security group name", - "name": "securitygroupname", + "description": "the protocol of the security group rule", + "name": "protocol", "type": "string" } ], "type": "set" - } - ], - "type": "set" - }, - { - "description": "the read (io) of disk on the vm", - "name": "diskioread", - "type": "long" - }, - { - "description": "the name of the host for the virtual machine", - "name": "hostname", - "type": "string" - }, - { - "description": "the internal memory that's free in vm or zero if it can not be calculated", - "name": "memoryintfreekbs", - "type": "long" - }, - { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" - }, - { - "description": "Guest vm Boot Type", - "name": "boottype", - "type": "string" - }, - { - "description": "the name of the virtual machine", - "name": "name", - "type": "string" - }, - { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" - }, - { - "description": "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": "the amount of the vm's CPU currently used", - "name": "cpuused", - "type": "string" - }, - {}, - { - "description": "the user's name who deployed the virtual machine", - "name": "username", - "type": "string" - }, - { - "description": "the pool type of the virtual machine", - "name": "pooltype", - "type": "string" - }, - { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", - "type": "string" - }, - { - "description": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" - }, - { - "description": "the target memory in vm", - "name": "memorytargetkbs", - "type": "long" - }, - { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", - "type": "string" - }, - { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", - "type": "string" - }, - { - "description": "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": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", - "type": "string" - }, - { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", - "type": "string" - }, - { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", - "type": "string" - }, - { - "description": "the password (if exists) of the virtual machine", - "name": "password", - "type": "string" - }, - { - "description": "the write (io) of disk on the vm", - "name": "diskiowrite", - "type": "long" - }, - { - "description": "State of the Service from LB rule", - "name": "servicestate", - "type": "string" - }, - { - "description": "the speed of each cpu", - "name": "cpuspeed", - "type": "integer" - }, - { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", - "type": "string" + }, + { + "description": "the domain ID of the security group", + "name": "domainid", + "type": "string" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the name of the security group", + "name": "name", + "type": "string" + }, + { + "description": "the domain name of the security group", + "name": "domain", + "type": "string" + }, + { + "description": "the project name of the group", + "name": "project", + "type": "string" + }, + { + "description": "the ID of the security group", + "name": "id", + "type": "string" + } + ], + "type": "set" }, { - "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" }, { @@ -119786,44 +121477,39 @@ "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", - "type": "string" - }, - { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", - "type": "string" + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", + "type": "boolean" }, { - "description": "the group name of the virtual machine", - "name": "group", + "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": "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": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", "type": "string" }, { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, { - "description": "the vgpu type used by the virtual machine", - "name": "vgpu", + "description": "the name of the host for the virtual machine", + "name": "hostname", "type": "string" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" }, { "description": "the ID of the disk offering of the virtual machine", @@ -119831,57 +121517,52 @@ "type": "string" }, { - "description": "device type of the root volume", - "name": "rootdevicetype", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", - "type": "boolean" + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", + "type": "string" }, { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", + "type": "string" }, { - "description": "the project name of the vm", - "name": "project", + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", "type": "string" }, { - "description": "the ID of the virtual machine", - "name": "id", + "description": "the name of the virtual machine", + "name": "name", "type": "string" }, { - "description": "the outgoing network traffic on the host", - "name": "networkkbswrite", + "description": "device ID of the root volume", + "name": "rootdeviceid", "type": "long" }, + { + "description": "the group name of the virtual machine", + "name": "group", + "type": "string" + }, { "description": "list of affinity groups associated with the virtual machine", "name": "affinitygroup", "response": [ - { - "description": "the name of the affinity group", - "name": "name", - "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 account owning the affinity group", - "name": "account", + "description": "the project name of the affinity group", + "name": "project", "type": "string" }, { @@ -119890,91 +121571,91 @@ "type": "string" }, { - "description": "the domain name of the affinity group", - "name": "domain", + "description": "the type of the affinity group", + "name": "type", "type": "string" }, { - "description": "the type of the affinity group", - "name": "type", + "description": "the name of the affinity group", + "name": "name", "type": "string" }, { - "description": "the project ID of the affinity group", - "name": "projectid", + "description": "the account owning the affinity group", + "name": "account", "type": "string" }, { - "description": "the project name of the affinity group", - "name": "project", + "description": "the project ID of the affinity group", + "name": "projectid", "type": "string" }, { "description": "the description of the affinity group", "name": "description", "type": "string" + }, + { + "description": "the domain name of the affinity group", + "name": "domain", + "type": "string" + }, + { + "description": "the ID of the affinity group", + "name": "id", + "type": "string" } ], "type": "set" }, { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" - }, - { - "description": "the read (bytes) of disk on the vm", - "name": "diskkbsread", - "type": "long" + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", + "type": "string" }, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", + "description": "the 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": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", + "type": "string" }, { - "description": "the ID of the availablility zone for the virtual machine", - "name": "zoneid", + "description": "OS type id of the vm", + "name": "ostypeid", "type": "string" }, { - "description": "the write (bytes) of disk on the vm", - "name": "diskkbswrite", + "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", + "description": "Os type ID of the virtual machine", + "name": "guestosid", "type": "string" }, { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the number of cpu this virtual machine is running with", - "name": "cpunumber", - "type": "integer" - }, - { - "description": "Guest vm Boot Mode", - "name": "bootmode", + "description": "ssh key-pairs", + "name": "keypairs", "type": "string" }, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", "type": "string" }, { - "description": "the project id of the vm", - "name": "projectid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -119983,116 +121664,67 @@ "type": "long" }, { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", - "type": "boolean" - }, - {}, - { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" - }, - { - "description": "the account associated with the virtual machine", - "name": "account", - "type": "string" - }, - { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", - "type": "string" - }, - {}, - { - "description": "the incoming network traffic on the vm", - "name": "networkkbsread", - "type": "long" - }, - { - "description": "the name of the disk offering of the virtual machine", - "name": "diskofferingname", + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", "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", - "type": "string" - }, - { - "description": "tag value", - "name": "value", + "description": "the ID of the nic", + "name": "id", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "true if nic is default, false otherwise", + "name": "macaddress", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the name of the corresponding network", + "name": "networkname", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "resource type", - "name": "resourcetype", - "type": "string" + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the ip address of the nic", + "name": "ipaddress", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" - }, - { - "description": "the list of nics associated with vm", - "name": "nic", - "response": [ - { - "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 gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { @@ -120101,18 +121733,18 @@ "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", - "type": "string" + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" }, { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", "type": "string" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "the netmask of the nic", + "name": "netmask", "type": "string" }, { @@ -120121,53 +121753,38 @@ "type": "string" }, { - "description": "the gateway of the nic", - "name": "gateway", + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "the isolation uri of the nic", + "name": "isolationuri", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "the gateway of the nic", + "name": "gateway", "type": "string" }, { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" - }, - { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - }, - { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "the ID of the corresponding network", + "name": "networkid", "type": "string" }, { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", "type": "string" }, { - "description": "the ip address of the nic", - "name": "ipaddress", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { @@ -120176,71 +121793,122 @@ "type": "integer" }, { - "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": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", - "type": "string" - }, - { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", "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 Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "the netmask of the nic", - "name": "netmask", + "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" } ], "type": "set" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" + }, + {}, + { + "description": "Guest vm Boot Type", + "name": "boottype", "type": "string" }, { - "description": "the memory used by the vm", - "name": "memorykbs", + "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": "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": "ssh key-pair", - "name": "keypair", + "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", + "description": "the project id of the vm", + "name": "projectid", + "type": "string" + }, + { + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", + "type": "string" + }, + { + "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", + "type": "long" + }, + { + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" + }, + { + "description": "the name of the template for the virtual machine", + "name": "templatename", + "type": "string" + }, + { + "description": "the ID of the host for the virtual machine", + "name": "hostid", + "type": "string" + }, + { + "description": "Guest vm Boot Mode", + "name": "bootmode", + "type": "string" + }, + { + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" + }, + { + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" + }, + { + "description": "the group ID of the virtual machine", + "name": "groupid", + "type": "string" + }, + { + "description": "the ID of the virtual machine", + "name": "id", + "type": "string" + }, + { + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", "type": "string" } ] @@ -120251,12 +121919,12 @@ "name": "createNetworkACLList", "params": [ { - "description": "ID of the VPC associated with this network ACL list", + "description": "an optional field, whether to the display the list to the end user or not", "length": 255, - "name": "vpcid", - "related": "createVPC,listVPCs,updateVPC", - "required": true, - "type": "uuid" + "name": "fordisplay", + "required": false, + "since": "4.4", + "type": "boolean" }, { "description": "Name of the network ACL list", @@ -120265,25 +121933,29 @@ "required": true, "type": "string" }, - { - "description": "an optional field, whether to the display the list to the end user or not", - "length": 255, - "name": "fordisplay", - "required": false, - "since": "4.4", - "type": "boolean" - }, { "description": "Description of the network ACL list", "length": 255, "name": "description", "required": false, "type": "string" + }, + { + "description": "ID of the VPC associated with this network ACL list", + "length": 255, + "name": "vpcid", + "related": "createVPC,listVPCs,updateVPC", + "required": true, + "type": "uuid" } ], "related": "", "response": [ - {}, + { + "description": "the ID of the ACL", + "name": "id", + "type": "string" + }, { "description": "Id of the VPC this ACL is associated with", "name": "vpcid", @@ -120291,28 +121963,29 @@ }, {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "Name of the VPC this ACL is associated with", + "name": "vpcname", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the Name of the ACL", + "name": "name", "type": "string" }, + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "is ACL for display to the regular user", "name": "fordisplay", "type": "boolean" }, { - "description": "the ID of the ACL", - "name": "id", - "type": "string" - }, - { - "description": "the Name of the ACL", - "name": "name", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -120323,5 +121996,5 @@ ] } ], - "count": 653 + "count": 650 } diff --git a/test/AddressService_test.go b/test/AddressService_test.go index 39a05c8..9d534cd 100644 --- a/test/AddressService_test.go +++ b/test/AddressService_test.go @@ -89,4 +89,16 @@ func TestAddressService(t *testing.T) { } t.Run("UpdateIpAddress", testupdateIpAddress) + testreleaseIpAddress := func(t *testing.T) { + if _, ok := response["releaseIpAddress"]; !ok { + t.Skipf("Skipping as no json response is provided in testdata") + } + p := client.Address.NewReleaseIpAddressParams("id") + _, err := client.Address.ReleaseIpAddress(p) + if err != nil { + t.Errorf(err.Error()) + } + } + t.Run("ReleaseIpAddress", testreleaseIpAddress) + } diff --git a/test/FirewallService_test.go b/test/FirewallService_test.go index daef845..6e00e0c 100644 --- a/test/FirewallService_test.go +++ b/test/FirewallService_test.go @@ -245,4 +245,58 @@ func TestFirewallService(t *testing.T) { } t.Run("UpdatePortForwardingRule", testupdatePortForwardingRule) + testlistIpv6FirewallRules := func(t *testing.T) { + if _, ok := response["listIpv6FirewallRules"]; !ok { + t.Skipf("Skipping as no json response is provided in testdata") + } + p := client.Firewall.NewListIpv6FirewallRulesParams() + _, err := client.Firewall.ListIpv6FirewallRules(p) + if err != nil { + t.Errorf(err.Error()) + } + } + t.Run("ListIpv6FirewallRules", testlistIpv6FirewallRules) + + testcreateIpv6FirewallRule := func(t *testing.T) { + if _, ok := response["createIpv6FirewallRule"]; !ok { + t.Skipf("Skipping as no json response is provided in testdata") + } + p := client.Firewall.NewCreateIpv6FirewallRuleParams("networkid", "protocol") + r, err := client.Firewall.CreateIpv6FirewallRule(p) + if err != nil { + t.Errorf(err.Error()) + } + if r.Id == "" { + t.Errorf("Failed to parse response. ID not found") + } + } + t.Run("CreateIpv6FirewallRule", testcreateIpv6FirewallRule) + + testupdateIpv6FirewallRule := func(t *testing.T) { + if _, ok := response["updateIpv6FirewallRule"]; !ok { + t.Skipf("Skipping as no json response is provided in testdata") + } + p := client.Firewall.NewUpdateIpv6FirewallRuleParams("id") + r, err := client.Firewall.UpdateIpv6FirewallRule(p) + if err != nil { + t.Errorf(err.Error()) + } + if r.Id == "" { + t.Errorf("Failed to parse response. ID not found") + } + } + t.Run("UpdateIpv6FirewallRule", testupdateIpv6FirewallRule) + + testdeleteIpv6FirewallRule := func(t *testing.T) { + if _, ok := response["deleteIpv6FirewallRule"]; !ok { + t.Skipf("Skipping as no json response is provided in testdata") + } + p := client.Firewall.NewDeleteIpv6FirewallRuleParams("id") + _, err := client.Firewall.DeleteIpv6FirewallRule(p) + if err != nil { + t.Errorf(err.Error()) + } + } + t.Run("DeleteIpv6FirewallRule", testdeleteIpv6FirewallRule) + } diff --git a/test/InfrastructureUsageService_test.go b/test/InfrastructureUsageService_test.go new file mode 100644 index 0000000..a852f82 --- /dev/null +++ b/test/InfrastructureUsageService_test.go @@ -0,0 +1,62 @@ +// +// Licensed to the Apache Software Foundation (ASF) under one +// or more contributor license agreements. See the NOTICE file +// distributed with this work for additional information +// regarding copyright ownership. The ASF licenses this file +// to you under the Apache License, Version 2.0 (the +// "License"); you may not use this file except in compliance +// with the License. You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, +// software distributed under the License is distributed on an +// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +// KIND, either express or implied. See the License for the +// specific language governing permissions and limitations +// under the License. +// + +package test + +import ( + "testing" + + "github.com/apache/cloudstack-go/v2/cloudstack" +) + +func TestInfrastructureUsageService(t *testing.T) { + service := "InfrastructureUsageService" + response, err := readData(service) + if err != nil { + t.Skipf("Skipping test as %v", err) + } + server := CreateTestServer(t, response) + client := cloudstack.NewClient(server.URL, "APIKEY", "SECRETKEY", true) + defer server.Close() + + testlistManagementServersMetrics := func(t *testing.T) { + if _, ok := response["listManagementServersMetrics"]; !ok { + t.Skipf("Skipping as no json response is provided in testdata") + } + p := client.InfrastructureUsage.NewListManagementServersMetricsParams() + _, err := client.InfrastructureUsage.ListManagementServersMetrics(p) + if err != nil { + t.Errorf(err.Error()) + } + } + t.Run("ListManagementServersMetrics", testlistManagementServersMetrics) + + testlistDbMetrics := func(t *testing.T) { + if _, ok := response["listDbMetrics"]; !ok { + t.Skipf("Skipping as no json response is provided in testdata") + } + p := client.InfrastructureUsage.NewListDbMetricsParams() + _, err := client.InfrastructureUsage.ListDbMetrics(p) + if err != nil { + t.Errorf(err.Error()) + } + } + t.Run("ListDbMetrics", testlistDbMetrics) + +} diff --git a/test/NetworkService_test.go b/test/NetworkService_test.go index 930cea8..4e408c0 100644 --- a/test/NetworkService_test.go +++ b/test/NetworkService_test.go @@ -407,4 +407,91 @@ func TestNetworkService(t *testing.T) { } t.Run("UpdateStorageNetworkIpRange", testupdateStorageNetworkIpRange) + testdeleteGuestNetworkIpv6Prefix := func(t *testing.T) { + if _, ok := response["deleteGuestNetworkIpv6Prefix"]; !ok { + t.Skipf("Skipping as no json response is provided in testdata") + } + p := client.Network.NewDeleteGuestNetworkIpv6PrefixParams("id") + _, err := client.Network.DeleteGuestNetworkIpv6Prefix(p) + if err != nil { + t.Errorf(err.Error()) + } + } + t.Run("DeleteGuestNetworkIpv6Prefix", testdeleteGuestNetworkIpv6Prefix) + + testcreateGuestNetworkIpv6Prefix := func(t *testing.T) { + if _, ok := response["createGuestNetworkIpv6Prefix"]; !ok { + t.Skipf("Skipping as no json response is provided in testdata") + } + p := client.Network.NewCreateGuestNetworkIpv6PrefixParams("prefix", "zoneid") + r, err := client.Network.CreateGuestNetworkIpv6Prefix(p) + if err != nil { + t.Errorf(err.Error()) + } + if r.Id == "" { + t.Errorf("Failed to parse response. ID not found") + } + } + t.Run("CreateGuestNetworkIpv6Prefix", testcreateGuestNetworkIpv6Prefix) + + testlistGuestNetworkIpv6Prefixes := func(t *testing.T) { + if _, ok := response["listGuestNetworkIpv6Prefixes"]; !ok { + t.Skipf("Skipping as no json response is provided in testdata") + } + p := client.Network.NewListGuestNetworkIpv6PrefixesParams() + _, err := client.Network.ListGuestNetworkIpv6Prefixes(p) + if err != nil { + t.Errorf(err.Error()) + } + } + t.Run("ListGuestNetworkIpv6Prefixes", testlistGuestNetworkIpv6Prefixes) + + testcreateNetworkPermissions := func(t *testing.T) { + if _, ok := response["createNetworkPermissions"]; !ok { + t.Skipf("Skipping as no json response is provided in testdata") + } + p := client.Network.NewCreateNetworkPermissionsParams("networkid") + _, err := client.Network.CreateNetworkPermissions(p) + if err != nil { + t.Errorf(err.Error()) + } + } + t.Run("CreateNetworkPermissions", testcreateNetworkPermissions) + + testresetNetworkPermissions := func(t *testing.T) { + if _, ok := response["resetNetworkPermissions"]; !ok { + t.Skipf("Skipping as no json response is provided in testdata") + } + p := client.Network.NewResetNetworkPermissionsParams("networkid") + _, err := client.Network.ResetNetworkPermissions(p) + if err != nil { + t.Errorf(err.Error()) + } + } + t.Run("ResetNetworkPermissions", testresetNetworkPermissions) + + testlistNetworkPermissions := func(t *testing.T) { + if _, ok := response["listNetworkPermissions"]; !ok { + t.Skipf("Skipping as no json response is provided in testdata") + } + p := client.Network.NewListNetworkPermissionsParams("networkid") + _, err := client.Network.ListNetworkPermissions(p) + if err != nil { + t.Errorf(err.Error()) + } + } + t.Run("ListNetworkPermissions", testlistNetworkPermissions) + + testremoveNetworkPermissions := func(t *testing.T) { + if _, ok := response["removeNetworkPermissions"]; !ok { + t.Skipf("Skipping as no json response is provided in testdata") + } + p := client.Network.NewRemoveNetworkPermissionsParams("networkid") + _, err := client.Network.RemoveNetworkPermissions(p) + if err != nil { + t.Errorf(err.Error()) + } + } + t.Run("RemoveNetworkPermissions", testremoveNetworkPermissions) + } diff --git a/test/SSHService_test.go b/test/SSHService_test.go index 5995106..d3ade54 100644 --- a/test/SSHService_test.go +++ b/test/SSHService_test.go @@ -93,7 +93,7 @@ func TestSSHService(t *testing.T) { if _, ok := response["resetSSHKeyForVirtualMachine"]; !ok { t.Skipf("Skipping as no json response is provided in testdata") } - p := client.SSH.NewResetSSHKeyForVirtualMachineParams("id", "keypair") + p := client.SSH.NewResetSSHKeyForVirtualMachineParams("id") r, err := client.SSH.ResetSSHKeyForVirtualMachine(p) if err != nil { t.Errorf(err.Error()) diff --git a/test/SystemVMService_test.go b/test/SystemVMService_test.go index 480789b..e958d72 100644 --- a/test/SystemVMService_test.go +++ b/test/SystemVMService_test.go @@ -152,4 +152,16 @@ func TestSystemVMService(t *testing.T) { } t.Run("StopSystemVm", teststopSystemVm) + testpatchSystemVm := func(t *testing.T) { + if _, ok := response["patchSystemVm"]; !ok { + t.Skipf("Skipping as no json response is provided in testdata") + } + p := client.SystemVM.NewPatchSystemVmParams() + _, err := client.SystemVM.PatchSystemVm(p) + if err != nil { + t.Errorf(err.Error()) + } + } + t.Run("PatchSystemVm", testpatchSystemVm) + } diff --git a/test/TemplateService_test.go b/test/TemplateService_test.go index cacd61f..a41df24 100644 --- a/test/TemplateService_test.go +++ b/test/TemplateService_test.go @@ -194,4 +194,28 @@ func TestTemplateService(t *testing.T) { } t.Run("UpgradeRouterTemplate", testupgradeRouterTemplate) + testlistTemplateDirectDownloadCertificates := func(t *testing.T) { + if _, ok := response["listTemplateDirectDownloadCertificates"]; !ok { + t.Skipf("Skipping as no json response is provided in testdata") + } + p := client.Template.NewListTemplateDirectDownloadCertificatesParams() + _, err := client.Template.ListTemplateDirectDownloadCertificates(p) + if err != nil { + t.Errorf(err.Error()) + } + } + t.Run("ListTemplateDirectDownloadCertificates", testlistTemplateDirectDownloadCertificates) + + testprovisionTemplateDirectDownloadCertificate := func(t *testing.T) { + if _, ok := response["provisionTemplateDirectDownloadCertificate"]; !ok { + t.Skipf("Skipping as no json response is provided in testdata") + } + p := client.Template.NewProvisionTemplateDirectDownloadCertificateParams("hostid", "id") + _, err := client.Template.ProvisionTemplateDirectDownloadCertificate(p) + if err != nil { + t.Errorf(err.Error()) + } + } + t.Run("ProvisionTemplateDirectDownloadCertificate", testprovisionTemplateDirectDownloadCertificate) + } diff --git a/test/UsageService_test.go b/test/UsageService_test.go index 992ce02..bd7a1e3 100644 --- a/test/UsageService_test.go +++ b/test/UsageService_test.go @@ -188,4 +188,16 @@ func TestUsageService(t *testing.T) { } t.Run("UpdateTrafficType", testupdateTrafficType) + testlistUsageServerMetrics := func(t *testing.T) { + if _, ok := response["listUsageServerMetrics"]; !ok { + t.Skipf("Skipping as no json response is provided in testdata") + } + p := client.Usage.NewListUsageServerMetricsParams() + _, err := client.Usage.ListUsageServerMetrics(p) + if err != nil { + t.Errorf(err.Error()) + } + } + t.Run("ListUsageServerMetrics", testlistUsageServerMetrics) + } diff --git a/test/VLANService_test.go b/test/VLANService_test.go index e7b1bfe..bbc1c76 100644 --- a/test/VLANService_test.go +++ b/test/VLANService_test.go @@ -113,4 +113,16 @@ func TestVLANService(t *testing.T) { } t.Run("ReleaseDedicatedGuestVlanRange", testreleaseDedicatedGuestVlanRange) + testlistGuestVlans := func(t *testing.T) { + if _, ok := response["listGuestVlans"]; !ok { + t.Skipf("Skipping as no json response is provided in testdata") + } + p := client.VLAN.NewListGuestVlansParams() + _, err := client.VLAN.ListGuestVlans(p) + if err != nil { + t.Errorf(err.Error()) + } + } + t.Run("ListGuestVlans", testlistGuestVlans) + } diff --git a/test/VPCService_test.go b/test/VPCService_test.go index 511e20d..d045a89 100644 --- a/test/VPCService_test.go +++ b/test/VPCService_test.go @@ -39,7 +39,7 @@ func TestVPCService(t *testing.T) { if _, ok := response["createPrivateGateway"]; !ok { t.Skipf("Skipping as no json response is provided in testdata") } - p := client.VPC.NewCreatePrivateGatewayParams("gateway", "ipaddress", "netmask", "vlan", "vpcid") + p := client.VPC.NewCreatePrivateGatewayParams("gateway", "ipaddress", "netmask", "vpcid") r, err := client.VPC.CreatePrivateGateway(p) if err != nil { t.Errorf(err.Error()) diff --git a/test/VirtualMachineService_test.go b/test/VirtualMachineService_test.go index 4a8785f..3fb706c 100644 --- a/test/VirtualMachineService_test.go +++ b/test/VirtualMachineService_test.go @@ -347,4 +347,16 @@ func TestVirtualMachineService(t *testing.T) { } t.Run("UpdateVirtualMachine", testupdateVirtualMachine) + testlistVirtualMachinesUsageHistory := func(t *testing.T) { + if _, ok := response["listVirtualMachinesUsageHistory"]; !ok { + t.Skipf("Skipping as no json response is provided in testdata") + } + p := client.VirtualMachine.NewListVirtualMachinesUsageHistoryParams() + _, err := client.VirtualMachine.ListVirtualMachinesUsageHistory(p) + if err != nil { + t.Errorf(err.Error()) + } + } + t.Run("ListVirtualMachinesUsageHistory", testlistVirtualMachinesUsageHistory) + } diff --git a/test/VolumeService_test.go b/test/VolumeService_test.go index 1869db2..1ff7efd 100644 --- a/test/VolumeService_test.go +++ b/test/VolumeService_test.go @@ -269,4 +269,19 @@ func TestVolumeService(t *testing.T) { } t.Run("UploadVolume", testuploadVolume) + testchangeOfferingForVolume := func(t *testing.T) { + if _, ok := response["changeOfferingForVolume"]; !ok { + t.Skipf("Skipping as no json response is provided in testdata") + } + p := client.Volume.NewChangeOfferingForVolumeParams("diskofferingid", "id") + r, err := client.Volume.ChangeOfferingForVolume(p) + if err != nil { + t.Errorf(err.Error()) + } + if r.Id == "" { + t.Errorf("Failed to parse response. ID not found") + } + } + t.Run("ChangeOfferingForVolume", testchangeOfferingForVolume) + } diff --git a/test/testdata/KubernetesService.json b/test/testdata/KubernetesService.json index 003b7ea..df7600c 100644 --- a/test/testdata/KubernetesService.json +++ b/test/testdata/KubernetesService.json @@ -2,20 +2,56 @@ "addKubernetesSupportedVersion": { "addkubernetessupportedversionresponse": { "kubernetessupportedversion": { - "id": "14dbb2cd-c8ee-4acd-85a5-c5672bcfe5ed", - "name": "v1.22.6", - "semanticversion": "1.22.6", - "isoid": "4415fb4d-9e47-4df1-a679-523f020480ce", - "isoname": "v1.22.6-Kubernetes-Binaries-ISO", + "id": "5bf7dd2b-49af-46c6-8a5b-3fc08c274527", + "name": "v1.23.3", + "semanticversion": "1.23.3", + "isoid": "ae158e0f-f65f-4f53-a604-24fe7e0b6764", + "isoname": "v1.23.3-Kubernetes-Binaries-ISO", "isostate": "Creating", "supportsha": true, "supportsautoscaling": true, "state": "Enabled", "mincpunumber": 2, - "minmemory": 2048 + "minmemory": 2048, + "created": "2023-03-16T08:11:40+0000" } } }, + "listKubernetesSupportedVersions": { + "listkubernetessupportedversionsresponse": { + "count": 2, + "kubernetessupportedversion": [ + { + "id": "5bf7dd2b-49af-46c6-8a5b-3fc08c274527", + "name": "v1.23.3", + "semanticversion": "1.23.3", + "isoid": "ae158e0f-f65f-4f53-a604-24fe7e0b6764", + "isoname": "v1.23.3-Kubernetes-Binaries-ISO", + "isostate": "Ready", + "supportsha": true, + "supportsautoscaling": true, + "state": "Enabled", + "mincpunumber": 2, + "minmemory": 2048, + "created": "2023-03-16T08:11:40+0000" + }, + { + "id": "e46d9557-9f81-4421-be9d-75d0195a034a", + "name": "v1.24.0", + "semanticversion": "1.24.0", + "isoid": "1724ed6b-8224-49f4-bc63-4ed766c83e3d", + "isoname": "v1.24.0-Kubernetes-Binaries-ISO", + "isostate": "Creating", + "supportsha": true, + "supportsautoscaling": true, + "state": "Enabled", + "mincpunumber": 2, + "minmemory": 2048, + "created": "2023-03-16T08:14:00+0000" + } + ] + } + }, "createKubernetesCluster": { "createkubernetesclusterresponse": { "accountid": "10e433e3-ba1a-11ec-bdce-1e000700021c",